Struct Object 

pub struct Object<S = DefaultStr>(pub BTreeMap<SmolStr, Data<S>>)
where
    S: Bos<str> + AsRef<str>;

Object/map of AT Protocol data values

Tuple Fields

0: BTreeMap<SmolStr, Data<S>>

Implementations

impl<S: Bos<str> + AsRef<str>> Object<S>

pub fn convert<B: Bos<str> + AsRef<str> + From<S>>(self) -> Object<B>

Convert to an Object with a different backing type.

impl<S> Object<S>

where S: AsRef<str> + Bos<str>,

pub fn get(&self, key: &str) -> Option<&Data<S>>

Get a value by key

pub fn get_mut(&mut self, key: &str) -> Option<&mut Data<S>>

Get a mutable reference to a value by key

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

Check if a key exists in the object

pub fn len(&self) -> usize

Get the number of key-value pairs in the object

pub fn is_empty(&self) -> bool

Check if the object is empty

pub fn iter(&self) -> Iter<'_, SmolStr, Data<S>>

Get an iterator over the key-value pairs

pub fn keys(&self) -> Keys<'_, SmolStr, Data<S>>

Get an iterator over the keys

pub fn type_discriminator(&self) -> Option<&str>

Get the “$type” discriminator field if present and it’s a string

This is a shortcut for union type discrimination in AT Protocol.

pub fn values(&self) -> Values<'_, SmolStr, Data<S>>

Get an iterator over the values

Trait Implementations

impl<S> Clone for Object<S>

where S: Bos<str> + AsRef<str> + Clone,

fn clone(&self) -> Object<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Object<S>

where S: Bos<str> + AsRef<str> + Debug,

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

Formats the value using the given formatter.

impl<'de, 'a, S> Deserialize<'de> for Object<S>

where S: AsRef<str> + Bos<str> + Deserialize<'de>, 'de: 'a,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S> Eq for Object<S>

where S: Bos<str> + AsRef<str> + Eq,

impl<S> From<BTreeMap<SmolStr, Data<S>>> for Object<S>

where S: AsRef<str> + Bos<str>,

fn from(value: BTreeMap<SmolStr, Data<S>>) -> Self

Converts to this type from the input type.

impl<S> From<Object<S>> for Data<S>

where S: AsRef<str> + Bos<str>,

fn from(t: Object<S>) -> Self

Converts to this type from the input type.

impl<S> Index<&str> for Object<S>

where S: AsRef<str> + Bos<str>,

type Output = Data<S>

The returned type after indexing.

fn index(&self, key: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<S> IntoStatic for Object<S>

where S: Bos<str> + AsRef<str> + IntoStatic, <S as IntoStatic>::Output: AsRef<str> + Bos<str>,

type Output = Object<<S as IntoStatic>::Output>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.

fn into_static(self) -> Object<<S as IntoStatic>::Output>

Turns the value into an “owned” variant, which can then be returned, moved, etc.

impl<S> PartialEq for Object<S>

where S: Bos<str> + AsRef<str> + PartialEq,

fn eq(&self, other: &Object<S>) -> 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<D> Serialize for Object<D>

where D: AsRef<str> + Bos<str> + Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<S> StructuralPartialEq for Object<S>

where S: Bos<str> + AsRef<str>,

impl<S> TryFrom<Data<S>> for Object<S>

where S: AsRef<str> + Bos<str> + 'static,

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(ipld: Data<S>) -> Result<Self, Self::Error>

Performs the conversion.