oxide_core 0.4.0

Rust engine primitives for Oxide (store, snapshot streams, error model, optional persistence).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

// Snapshot model used by both Rust and binding layers.
//
// Why: Exposing a small `{revision, state}` payload makes it easy for consumers
// to reason about update ordering and to build reactive streams on top.
/// Versioned snapshot of store state.
///
/// A snapshot is broadcast to subscribers when the engine commits a new state
/// (i.e. when a reducer returns [`crate::StateChange::Full`]).
///
/// Revisions start at `0` and increment by 1 for each committed update.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(
    feature = "state-persistence",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct StateSnapshot<T, StateSlice = ()> {
    /// Monotonically increasing revision number, starting at `0`.
    pub revision: u64,
    /// The state value for the given revision.
    pub state: T,
    /// Slice metadata describing which top-level segments of state changed.
    ///
    /// This is only populated when sliced updates are enabled and reducers opt
    /// into emitting slice metadata.
    pub slices: Vec<StateSlice>,
}