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>> + Ord, V: Into<Value<'v>> + DynamicType,

Add a new entry.

pub fn get<'d, K, V>(&'d self, key: &'k K) -> Result<Option<V>, Error>

where &'k K: TryInto<Value<'k>>, <&'k K as TryInto<Value<'k>>>::Error: Into<Error>, V: TryFrom<&'v Value<'v>>, <V as TryFrom<&'v Value<'v>>>::Error: Into<Error>, '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.

pub fn try_clone(&self) -> Result<Self, Error>

Try to clone the Dict.

Trait Implementations

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

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

Formats the value using the given formatter.

impl Display for Dict<'_, '_>

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

Formats the value using the given formatter.

impl<'k, 'v, K, V> From<BTreeMap<K, V>> for Dict<'k, 'v>

where K: Type + Into<Value<'k>>, V: Type + Into<Value<'v>>,

fn from(value: BTreeMap<K, V>) -> 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>>, V: Type + Into<Value<'v>>, H: BuildHasher,

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

Converts to this type from the input type.

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

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

fn cmp(&self, other: &Dict<'k, 'v>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'k, 'v> PartialEq 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> PartialOrd for Dict<'k, 'v>

fn partial_cmp(&self, other: &Dict<'k, 'v>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

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 Dict<'a, 'a>> for Value<'a>

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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<'_>> for &'a 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<'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<'a> TryFrom<Dict<'a, 'a>> for OwnedValue

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'k, 'v, K, V> TryFrom<Dict<'k, 'v>> for BTreeMap<K, V>

where K: Basic + TryFrom<Value<'k>> + Ord, V: TryFrom<Value<'v>>, 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<'k, 'v, K, V, H> TryFrom<Dict<'k, 'v>> for HashMap<K, V, H>

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

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> Eq for Dict<'k, 'v>

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