Skip to main content

WorldSnapshot

Struct WorldSnapshot 

Source
pub struct WorldSnapshot {
    pub entities: Vec<EntitySnapshot>,
    pub resources: Vec<ResourceSnapshot>,
    pub timestamp: f64,
    pub version: u32,
    pub metadata: HashMap<String, String>,
}
Expand description

A complete serialized snapshot of the world state at a point in time.

This is the primary unit passed to the save/load pipeline and the checkpoint manager.

Fields§

§entities: Vec<EntitySnapshot>

All entity snapshots.

§resources: Vec<ResourceSnapshot>

All resource snapshots.

§timestamp: f64

When this snapshot was taken, in seconds since some epoch (game time).

§version: u32

Schema version — used to detect incompatible save files.

§metadata: HashMap<String, String>

Free-form metadata (level name, player name, etc.).

Implementations§

Source§

impl WorldSnapshot

Source

pub fn new() -> Self

Create an empty snapshot.

Source

pub fn with_timestamp(self, ts: f64) -> Self

Create a snapshot with a specific timestamp.

Source

pub fn add_entity( &mut self, entity_id: u64, components: HashMap<String, SerializedValue>, )

Add or replace an entity snapshot.

Source

pub fn add_entity_snapshot(&mut self, snapshot: EntitySnapshot)

Add an entity snapshot directly.

Source

pub fn add_resource( &mut self, type_name: impl Into<String>, value: SerializedValue, )

Add or replace a resource snapshot.

Source

pub fn set_meta(&mut self, key: impl Into<String>, value: impl Into<String>)

Set a metadata key.

Source

pub fn get_meta(&self, key: &str) -> Option<&str>

Get a metadata value.

Source

pub fn entity_count(&self) -> usize

Number of entity snapshots.

Source

pub fn resource_count(&self) -> usize

Number of resource snapshots.

Source

pub fn get_entity(&self, id: u64) -> Option<&EntitySnapshot>

Find an entity snapshot by id.

Source

pub fn get_entity_mut(&mut self, id: u64) -> Option<&mut EntitySnapshot>

Find a mutable entity snapshot by id.

Source

pub fn get_resource(&self, type_name: &str) -> Option<&ResourceSnapshot>

Find a resource snapshot by type name.

Source

pub fn remove_entity(&mut self, id: u64) -> bool

Remove an entity by id. Returns true if it was found.

Source

pub fn merge(&mut self, other: &WorldSnapshot)

Merge other into self. Entities and resources in other override self.

Source

pub fn diff(&self, other: &WorldSnapshot) -> SnapshotDiff

Compute the changes from self (old) to other (new).

Source

pub fn apply_diff(&mut self, diff: &SnapshotDiff)

Apply a SnapshotDiff to produce an updated snapshot.

Trait Implementations§

Source§

impl Clone for WorldSnapshot

Source§

fn clone(&self) -> WorldSnapshot

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorldSnapshot

Source§

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

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

impl Default for WorldSnapshot

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> 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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,