Struct plist::dictionary::Dictionary

pub struct Dictionary { /* fields omitted */ }

Represents a plist dictionary type.

Implementations

impl Dictionary

pub fn new() -> Self

Makes a new empty Dictionary.

pub fn clear(&mut self)

Clears the dictionary, removing all values.

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

Returns a reference to the value corresponding to the key.

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

Returns true if the dictionary contains a value for the specified key.

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

Returns a mutable reference to the value corresponding to the key.

pub fn insert(&mut self, k: String, v: Value) -> Option<Value>

Inserts a key-value pair into the dictionary.

If the dictionary did not have this key present, None is returned.

If the dictionary did have this key present, the value is updated, and the old value is returned.

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

Removes a key from the dictionary, returning the value at the key if the key was previously in the dictionary.

pub fn retain<F>(&mut self, keep: F) where
    F: FnMut(&String, &mut Value) -> bool, 

Scan through each key-value pair in the map and keep those where the closure keep returns true.

pub fn sort_keys(&mut self)

Sort the dictionary keys.

This uses the default ordering defined on str.

This function is useful if you are serializing to XML, and wish to ensure a consistent key order.

pub fn len(&self) -> usize

Returns the number of elements in the dictionary.

pub fn is_empty(&self) -> bool

Returns true if the dictionary contains no elements.

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the dictionary.

pub fn iter_mut(&mut self) -> IterMut<'_>

Gets a mutable iterator over the entries of the dictionary.

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

Gets an iterator over the keys of the dictionary.

pub fn values(&self) -> Values<'_>

Gets an iterator over the values of the dictionary.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Gets an iterator over mutable values of the dictionary.

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Self

Returns the “default value” for a type.

impl Extend<(String, Value)> for Dictionary

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (String, Value)>, 

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Dictionary> for Value

fn from(from: Dictionary) -> Value

Performs the conversion.

impl FromIterator<(String, Value)> for Dictionary

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

Creates a value from an iterator.

impl<'a> Index<&'a str> for Dictionary

Access an element of this dictionary. Panics if the given key is not present in the dictionary.

match *val {
    Value::Array(ref arr) => arr[0].as_string(),
    Value::Dictionary(ref dict) => dict["type"].as_string(),
    Value::String(ref s) => Some(s.as_str()),
    _ => None,
}

type Output = Value

The returned type after indexing.

fn index(&self, index: &str) -> &Value

Performs the indexing (container[index]) operation.

impl<'a> IndexMut<&'a str> for Dictionary

Mutably access an element of this dictionary. Panics if the given key is not present in the dictionary.

dict["key"] = "value".into();

fn index_mut(&mut self, index: &str) -> &mut Value

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Dictionary

type Item = (&'a String, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Dictionary

type Item = (&'a String, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Dictionary

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Dictionary> for Dictionary

fn eq(&self, other: &Self) -> 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 !=.