Struct NippyJarChecker

pub struct NippyJarChecker<H: NippyJarHeader = ()> { /* private fields */ }

Performs consistency checks or heals on the NippyJar file

• Is the offsets file size expected?
• Is the data file size expected?

This is based on the assumption that NippyJar configuration is always the last one to be updated when something is written, as by the NippyJarWriter::commit() function shows.

For checks (read-only) use check_consistency method.

For heals (read-write) use ensure_consistency method.

Implementations

impl<H: NippyJarHeader> NippyJarChecker<H>

pub const fn new(jar: NippyJar<H>) -> Self

Creates a new instance of NippyJarChecker with the provided NippyJar.

This method initializes the checker without any associated file handles for the data or offsets files. The NippyJar passed in contains all necessary configurations for handling data.

pub fn check_consistency(&mut self) -> Result<(), NippyJarError>

It will throw an error if the NippyJar is in a inconsistent state.

pub fn ensure_consistency(&mut self) -> Result<(), NippyJarError>

It will attempt to heal if the NippyJar is in a inconsistent state.

ATTENTION: disk commit should be handled externally by consuming Self

Trait Implementations

impl<H: Debug + NippyJarHeader> Debug for NippyJarChecker<H>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.