Skip to main content

StateSnapshot

Struct StateSnapshot 

Source
pub struct StateSnapshot {
    pub globals: BTreeMap<String, Value>,
    pub lists: BTreeMap<String, SnapshotList>,
    pub turn_index: u32,
    pub visit_counts: BTreeMap<String, u32>,
    pub turn_counts: BTreeMap<String, u32>,
    pub call_stack: Vec<SnapshotFrame>,
    pub status: SnapshotStatus,
}
Expand description

A typed, name-resolved snapshot of a session’s game state.

A NEW typed serialization path — distinct from the string-valued DebugSnapshot. Globals keep their Values (list membership included via SnapshotList); callstack is summarized to frame kinds + resolved locations. Deterministic (BTreeMap / sorted vectors).

Fields§

§globals: BTreeMap<String, Value>

Global variables by name, typed. BTreeMap for determinism.

§lists: BTreeMap<String, SnapshotList>

Resolved list memberships for any List-valued global, keyed by variable name (item names, sorted). Complements globals for consumers that want membership without decoding DefinitionIds.

§turn_index: u32

Global turn index.

§visit_counts: BTreeMap<String, u32>

Per-knot/stitch visit counts, keyed by resolved path, sorted.

Path-keyed projection: counts for scopes with no resolvable author path (anonymous counted containers — gathers, choice points — keyed only by hash id) are omitted here. This is the known projection limit of the typed snapshot; the full id-keyed counts remain available via StorySession::save_state.

§turn_counts: BTreeMap<String, u32>

Per-knot/stitch turn-since counts, keyed by resolved path, sorted. Same path-keyed projection limit as visit_counts.

§call_stack: Vec<SnapshotFrame>

Callstack summary of the default flow, innermost frame first.

§status: SnapshotStatus

Execution status.

Trait Implementations§

Source§

impl Clone for StateSnapshot

Source§

fn clone(&self) -> StateSnapshot

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 Debug for StateSnapshot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for StateSnapshot

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for StateSnapshot

Source§

fn eq(&self, other: &StateSnapshot) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for StateSnapshot

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for StateSnapshot

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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.