Skip to main content

ComponentSnapshot

Struct ComponentSnapshot 

Source
pub struct ComponentSnapshot {
    pub component_fqn: String,
    pub version: u32,
    pub state: Value,
    pub metadata: HashMap<String, Value>,
}
Expand description

Component state snapshot.

Stores a component’s serialized state along with metadata for safe restoration.

§Fields

  • component_fqn: Fully qualified name (namespace::name) for cross-session matching
  • version: Format version for compatibility checking
  • state: Serialized component state
  • metadata: Optional additional data (timestamps, checksums, etc.)

Fields§

§component_fqn: String

Fully qualified name (namespace::name) for validation.

Uses FQN instead of full ComponentId because UUIDs differ between sessions.

§version: u32

Snapshot format version.

§state: Value

Serialized component state.

§metadata: HashMap<String, Value>

Optional metadata.

Implementations§

Source§

impl ComponentSnapshot

Source

pub fn from_state<T: Serialize>( fqn: impl Into<String>, state: &T, ) -> Result<Self, SnapshotError>

Creates a new snapshot from serializable state.

§Arguments
  • fqn - The component’s fully qualified name (namespace::name)
  • state - The state to serialize
§Errors

Returns SnapshotError::Serialization if the state cannot be serialized.

Source

pub fn empty(fqn: impl Into<String>) -> Self

Creates an empty snapshot (for components with no state).

Source

pub fn to_state<T: for<'de> Deserialize<'de>>(&self) -> Result<T, SnapshotError>

Deserializes the state.

§Errors

Returns SnapshotError::Serialization if deserialization fails.

Source

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Adds metadata.

Source

pub fn validate(&self, expected_fqn: &str) -> Result<(), SnapshotError>

Validates that this snapshot matches the expected component.

§Errors

Returns an error if the FQN or version doesn’t match.

Source

pub fn is_empty(&self) -> bool

Returns true if the state is empty/null.

Trait Implementations§

Source§

impl Clone for ComponentSnapshot

Source§

fn clone(&self) -> ComponentSnapshot

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 ComponentSnapshot

Source§

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

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

impl<'de> Deserialize<'de> for ComponentSnapshot

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 Serialize for ComponentSnapshot

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,