Struct packs::Dictionary

pub struct Dictionary<T>(_);

A Dictionary is a map of String to Value<T> pairs. These pairs are also called properties and can be seen as named values. The type parameter denotes the allowed structures for a value.

Implementations

impl<T> Dictionary<T>

pub fn with_capacity(capacity: usize) -> Self

pub fn new() -> Self

pub fn from_inner(map: HashMap<String, Value<T>>) -> Self

pub fn into_inner(self) -> HashMap<String, Value<T>>

pub fn inner(&self) -> &HashMap<String, Value<T>>

pub fn add_property<V: Into<Value<T>>>(
    &mut self,
    key: &str,
    value: V
) -> Option<Value<T>>

Adds a key-value pair to the Dictionary. Returns the original value of the property if it was already set.

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

pub fn extract_property(&mut self, key: &str) -> Option<Value<T>>

pub fn extract_property_typed<V: Extract<T>>(&mut self, key: &str) -> Option<V>

Removes the property from the dictionary and returns it. Tries to extract the value strongly typed.

Panics if it cannot cast the value to provided type.

pub fn get_property(&self, key: &str) -> Option<&Value<T>>

Retrieves a property.

pub fn get_property_typed<V: ExtractRef<T>>(&self, key: &str) -> Option<&V>

Retrieves the value of a property in a strongly typed manner.

Panics if it cannot cast the value to provided type.

// create a Dictionary with a list of values as property:
let mut dict = Dictionary::with_capacity(1);
let list: Vec<Value<()>> = vec!(Value::Integer(1), Value::Boolean(true));
dict.add_property("foo", list.clone());

// retrieve this list:
let get_list = dict.get_property_typed("foo");
assert_eq!(Some(&list), get_list);

pub fn properties(&self) -> Iter<'_, String, Value<T>>

pub fn properties_mut(&mut self) -> IterMut<'_, String, Value<T>>

pub fn entry(&mut self, key: String) -> Entry<'_, String, Value<T>>

pub fn len(&self) -> usize

Trait Implementations

impl<T: Clone> Clone for Dictionary<T>

pub fn clone(&self) -> Dictionary<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Dictionary<T>

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

Formats the value using the given formatter.

impl<T> Extract<T> for Dictionary<T>

pub fn extract(from: Value<T>) -> Option<Self>

impl<T> ExtractMut<T> for Dictionary<T>

pub fn extract_mut(from: &mut Value<T>) -> Option<&mut Self>

pub fn extract_opt_mut(from: &mut Value<T>) -> Option<Option<&mut Self>>

impl<T> ExtractRef<T> for Dictionary<T>

pub fn extract_ref(from: &Value<T>) -> Option<&Self>

pub fn extract_opt_ref(from: &Value<T>) -> Option<Option<&Self>>

impl<T> FromIterator<(String, Value<T>)> for Dictionary<T>

pub fn from_iter<I: IntoIterator<Item = (String, Value<T>)>>(iter: I) -> Self

Creates a value from an iterator.

impl<P: Pack> Pack for Dictionary<P>

pub fn encode<T: Write>(&self, writer: &mut T) -> Result<usize, EncodeError>

impl<T: PartialEq> PartialEq<Dictionary<T>> for Dictionary<T>

pub fn eq(&self, other: &Dictionary<T>) -> bool

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

pub fn ne(&self, other: &Dictionary<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for Dictionary<T>

impl<P: Unpack> Unpack for Dictionary<P>

pub fn decode_body<T: Read>(
    marker: Marker,
    reader: &mut T
) -> Result<Self, DecodeError>

pub fn decode<T: Read>(reader: &mut T) -> Result<Self, DecodeError>