Skip to main content

Snapshot

Struct Snapshot 

Source
pub struct Snapshot<T> {
    pub format_version: u32,
    pub model: T,
}
Expand description

A versioned envelope around a serializable model state.

Versioning is centralized here so individual models do not need to duplicate format-version fields.

§Examples

use rill_ml::persistence::Snapshot;
use rill_ml::stats::Mean;
use rill_ml::OnlineStatistic;

let mut mean = Mean::new();
mean.update(1.0).unwrap();
mean.update(2.0).unwrap();

let snap = Snapshot::new(mean);
let json = serde_json::to_string(&snap).unwrap();
let restored: Snapshot<Mean> = serde_json::from_str(&json).unwrap();
let m = restored.into_model().unwrap();
assert!((m.value() - 1.5).abs() < 1e-12);

Fields§

§format_version: u32

The format version of this snapshot.

§model: T

The model state.

Implementations§

Source§

impl<T> Snapshot<T>

Source

pub fn new(model: T) -> Self

Wrap a model in a new snapshot with the current format version.

Source

pub fn into_model(self) -> Result<T, RillError>

Consume the snapshot and return the model, verifying the format version.

Returns RillError::IncompatibleStateVersion if the version does not match SNAPSHOT_FORMAT_VERSION.

Source

pub fn into_model_with_validation<F>(self, validate: F) -> Result<T, RillError>
where F: FnOnce(&T) -> Result<(), RillError>,

Consume the snapshot, verify its format version, and run an application-provided model-state validator before returning the model.

The snapshot envelope can only validate its own version field because T may be an application type. Use this method at trust boundaries to enforce model-specific invariants before activating restored state.

§Errors

Returns RillError::IncompatibleStateVersion for a version mismatch, or propagates the validator’s error.

Trait Implementations§

Source§

impl<T: Clone> Clone for Snapshot<T>

Source§

fn clone(&self) -> Snapshot<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Snapshot<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Snapshot<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Snapshot<T>
where T: RefUnwindSafe,

§

impl<T> Send for Snapshot<T>
where T: Send,

§

impl<T> Sync for Snapshot<T>
where T: Sync,

§

impl<T> Unpin for Snapshot<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Snapshot<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Snapshot<T>
where T: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V