Struct zvariant::Dict

pub struct Dict<'k, 'v> { /* private fields */ }

A helper type to wrap dictionaries in a Value.

API is provided to convert from, and to a HashMap.

Implementations

impl<'k, 'v> Dict<'k, 'v>

pub fn new(key_signature: Signature<'k>, value_signature: Signature<'v>) -> Self

Create a new empty Dict, given the signature of the keys and values.

pub fn append<'kv: 'k, 'vv: 'v>(
    &mut self,
    key: Value<'kv>,
    value: Value<'vv>
) -> Result<(), Error>

Append key and value as a new entry.

Errors

• if key.value_signature() doesn’t match the key signature self was created for.
• if value.value_signature() doesn’t match the value signature self was created for.

pub fn add<K, V>(&mut self, key: K, value: V) -> Result<(), Error>where
    K: Basic + Into<Value<'k>> + Hash + Eq,
    V: Into<Value<'v>> + DynamicType,

Add a new entry.

pub fn get<'d, K, V>(&'d self, key: &K) -> Result<Option<&'v V>, Error>where
    K: ?Sized + Eq + 'k,
    V: ?Sized,
    &'k K: TryFrom<&'k Value<'k>>,
    &'v V: TryFrom<&'v Value<'v>>,
    'd: 'k + 'v,

Get the value for the given key.

pub fn signature(&self) -> Signature<'static>

Get the signature of this Dict.

NB: This method potentially allocates and copies. Use full_signature if you’d like to avoid that.

pub fn full_signature(&self) -> &Signature<'_>

Get the signature of this Dict.

Trait Implementations

impl<'k, 'v> Clone for Dict<'k, 'v>

fn clone(&self) -> Dict<'k, 'v>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'k, 'v> Debug for Dict<'k, 'v>

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

Formats the value using the given formatter.

impl<'a> From<&'a Dict<'a, 'a>> for Value<'a>

fn from(v: &'a Dict<'a, 'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Dict<'a, 'a>> for OwnedValue

fn from(v: Dict<'a, 'a>) -> Self

Converts to this type from the input type.

impl<'a> From<Dict<'a, 'a>> for Value<'a>

fn from(v: Dict<'a, 'a>) -> Self

Converts to this type from the input type.

impl<'k, 'v, K, V, H> From<HashMap<K, V, H>> for Dict<'k, 'v>where
    K: Type + Into<Value<'k>> + Hash + Eq,
    V: Type + Into<Value<'v>>,
    H: BuildHasher + Default,

fn from(value: HashMap<K, V, H>) -> Self

Converts to this type from the input type.

impl<'k, 'v> PartialEq<Dict<'k, 'v>> for Dict<'k, 'v>

fn eq(&self, other: &Dict<'k, 'v>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'k, 'v> Serialize for Dict<'k, 'v>

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a OwnedValue> for &'a Dict<'a, 'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: &'a OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for &'a Dict<'a, 'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'a>> for Dict<'a, 'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &'a Value<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'k, 'v, K, V, H> TryFrom<Dict<'k, 'v>> for HashMap<K, V, H>where
    K: Basic + TryFrom<Value<'k>> + Hash + Eq,
    V: TryFrom<Value<'v>>,
    H: BuildHasher + Default,
    K::Error: Into<Error>,
    V::Error: Into<Error>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: Dict<'k, 'v>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OwnedValue> for Dict<'static, 'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(v: OwnedValue) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for Dict<'a, 'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'k, 'v> StructuralPartialEq for Dict<'k, 'v>