Struct FrameMetadata 

pub struct FrameMetadata {
    pub schema_version: u8,
    pub kind: FrameKind,
    pub conversation_id: String,
    pub chat_role: String,
    pub dedup_key: String,
    pub scope: Option<String>,
}

The typed schema written into a backend’s per-entry metadata map for every entry produced by a Rig memory lifecycle hook.

Downstream tools can decode the metadata map into this struct to reason about the origin of the retrieved entry.

Backends construct this envelope directly (struct literal); to keep that usage ergonomic across crate boundaries the struct is not #[non_exhaustive]. Any future field addition is therefore a breaking change and must bump the major version of this crate.

Fields

schema_version: u8

The schema version of this envelope. Currently 1.

kind: FrameKind

What kind of memory lifecycle produced this entry.

conversation_id: String

The conversation ID from the Rig CompactingMemory context.

chat_role: String

The logical chat role (system, user, assistant).

dedup_key: String

The deterministic content-hash dedup key.

scope: Option<String>

The isolation scope under which this entry was written, if any.

Implementations

impl FrameMetadata

pub fn try_from_map(map: &BTreeMap<String, String>) -> Result<Self, Error>

Attempt to parse the metadata envelope from a string-to-string dictionary.

pub fn into_map(self) -> BTreeMap<String, String>

Convert the metadata envelope into a string-to-string dictionary.

Trait Implementations

impl Clone for FrameMetadata

fn clone(&self) -> FrameMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FrameMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FrameMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FrameMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FrameMetadata

impl StructuralPartialEq for FrameMetadata