Skip to main content

SnapshotFsLoader

Struct SnapshotFsLoader 

Source
pub struct SnapshotFsLoader { /* private fields */ }
Expand description

A file system backed snapshot loader.

The loader opens a snapshot file and decodes it using the framed binary format written by SnapshotFsWriter:

  • 4 bytes version (currently 4)
  • 4 bytes length of payload
  • 4 bytes CRC-32 of payload
  • JSON-serialized Snapshot

Version checking is performed to ensure compatibility between the writer and loader. If the snapshot version does not match the expected version, SnapshotLoaderError::IncompatibleVersion is returned.

If the snapshot file does not exist, load() will return Ok(None) instead of panicking.

Implementations§

Source§

impl SnapshotFsLoader

Source

pub fn new(path: PathBuf) -> Self

Creates a new snapshot loader from the given path.

§Arguments
  • path - The filesystem path to the snapshot file
Source

pub fn with_version(path: PathBuf, version: u32) -> Self

Creates a new snapshot loader from the given path with a custom version.

This is useful for testing or when the loader needs to support multiple snapshot versions.

§Arguments
  • path - The filesystem path to the snapshot file
  • version - The expected snapshot version

Trait Implementations§

Source§

impl SnapshotLoader for SnapshotFsLoader

Source§

fn load(&mut self) -> Result<Option<Snapshot>, SnapshotLoaderError>

Load a snapshot from storage.

The loader reads the version frame, validates it against the expected version, then reads the length and payload frames. The payload is decoded from JSON into a Snapshot struct.

If the snapshot file does not exist, returns Ok(None).

§Errors

Returns SnapshotLoaderError::IoError if an I/O error occurs. Returns SnapshotLoaderError::IncompatibleVersion if the snapshot version does not match the expected version. Returns SnapshotLoaderError::DecodeError if the snapshot cannot be decoded.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more