Struct Record 

pub struct Record<'a> { /* private fields */ }

A map of named Values.

Record is the body of an object in the manifest. On the save side each call to crate::save::Save::save returns one, and Record::into_value wraps it as a Versioned Value::Object ready for insertion into another record; on the load side the same record is read back through crate::load::Object. Keys beginning with $ are reserved for framework metadata (see [crate::is_reserved]).

Implementations

impl<'a> Record<'a>

pub fn empty() -> Self

Construct an empty record. Useful for unit enum variants.

pub fn contains_key(&self, key: &str) -> bool

Returns true if a value is registered under key.

pub fn get(&self, key: &str) -> Option<&Value<'a>>

Look up the Value registered under key, if any.

pub fn len(&self) -> usize

Number of (user) keys in this record. Reserved keys ($version, $handle) are tracked elsewhere and never appear here.

pub fn is_empty(&self) -> bool

Returns true if this record has no user keys.

pub fn keys(&self) -> Keys<'_, 'a>

Iterate over the user keys in this record. Order is unspecified.

pub fn insert<K, V>(&mut self, key: K, value: V) -> Result<Option<Value<'a>>>

where K: Into<Cow<'a, str>>, V: Into<Value<'a>>,

Insert value under key.

Errors

Returns Error if key begins with $, which is reserved for the save/load framework (see [crate::is_reserved]).

pub fn into_value(self, version: Version) -> Value<'a>

Wrap this record as a versioned Value ready for insertion into another record. Use this from enum Save impls to attach the outer type’s version to an inline variant payload.

pub fn into_owned(self) -> Record<'static>

Convert this record into a fully owned Record<'static>, deep-copying borrowed keys and values. See Value::into_owned.

Trait Implementations

impl<'a> Debug for Record<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Record<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> FromIterator<(Cow<'a, str>, Value<'a>)> for Record<'a>

fn from_iter<I: IntoIterator<Item = (Cow<'a, str>, Value<'a>)>>(itr: I) -> Self

Creates a value from an iterator.

impl<'a> Serialize for Record<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.