Struct Dictionary

pub struct Dictionary<V>
where
    V: PartialEq + PartialOrd + Clone + Debug,
{ /* private fields */ }

A ‘dictionary’ is a ‘collection’ containing ‘string’ label keys associated with a value.

Implementations

impl<V> Dictionary<V>

where V: PartialEq + PartialOrd + Clone + Debug,

pub fn new() -> Self

Creates a new empty ‘dictionary’.

pub fn from_vec(v: &Vec<KeyValue<String, V>>) -> Self

Creates a new ‘dictionary’ that contains the elements in the specified vector.

Trait Implementations

impl<V> Clear for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn clear(&mut self)

Clears all the elements from this ‘dictionary’.

impl<V> Clone for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn clone(&self) -> Self

Returns a clone of this ‘dictionary’.

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

Performs copy-assignment from source.

impl<V> Collection for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

type Element = KeyValue<String, V>

The element type.

fn capacity(&self) -> usize

Returns the capacity of this ‘dictionary’.

fn contains(&self, item: &KeyValue<String, V>) -> bool

Returns true if this ‘dictionary’ contains the specified item.

fn contains_all(&self, vec: &Vec<KeyValue<String, V>>) -> bool

Returns true if this ‘dictionary’ contains the specified vector.

fn to_vec(&self) -> Vec<KeyValue<String, V>>

Returns this ‘dictionary’ as a ‘vector’.

impl<V> Debug for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

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

Displays debug information for this ‘dictionary’.

impl<V> Empty for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn is_empty(&self) -> bool

Returns true if this ‘dictionary’ is empty.

impl<V> Index<&str> for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

type Output = V

Output type.

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

Returns the value associated with the specified key.

Panics

This function panics if the key does not exist in this ‘dictionary’.

impl<V> Index<String> for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

type Output = V

Output type.

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

Returns the value associated with the specified key.

Panics

This function panics if the key does not exist in this ‘dictionary’.

impl<V> IndexMut<&str> for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

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

Returns the value associated with the specified key.

Panics

This function panics if the key does not exist in this ‘dictionary’.

impl<V> IndexMut<String> for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn index_mut(&mut self, index: String) -> &mut Self::Output

Returns the value associated with the specified key.

Panics

This function panics if the key does not exist in this ‘dictionary’.

impl<V> IntoIterator for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

type Item = KeyValue<String, V>

Item type.

type IntoIter = IntoIter<KeyValue<String, V>>

IntoIter type.

fn into_iter(self) -> Self::IntoIter

Returns an iterator for this ‘dictionary’.

impl<V> Len for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn len(&self) -> usize

Returns the length of this ‘dictionary’.

impl<V> MapCollection<String, V> for Dictionary<V>

where V: PartialEq + PartialOrd + Clone + Debug,

fn exists(&self, key: String) -> bool

Returns true if the specified key exists.

fn get(&self, key: String) -> Option<&V>

Returns the value associated with the specified key, or None if the key does not exist.

fn insert(&mut self, pair: KeyValue<String, V>) -> bool

Inserts a new key/value pair into this ‘dictionary’. Returns true is successful. Returns false if the key already exists.

fn remove(&mut self, key: String) -> bool

Removes the specified key, if it exists. Returns true if successful. Returns false if the specified key does not exist.

fn replace(&mut self, pair: KeyValue<String, V>) -> bool

Replaces the value associated with the specified key with the specified value. Returns true if successful. Returns false if the specified key does not exist.

impl<V> PartialEq for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn eq(&self, other: &Self) -> bool

Returns true if this ‘dictionary’ and the specified ‘dictionary’ are equal, meaning they are the same length and contain the same entries. For ‘dictionaries’, the order of the entries is irrelevant.

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<V> Sortable for Dictionary<V>

where V: Clone + Debug + PartialEq + PartialOrd,

fn is_sorted(&self) -> bool

Returns true if this ‘dictionary’ is sorted in ascending order.

fn is_sorted_rev(&self) -> bool

Returns true if this ‘dictionary’ is sorted in descending order.

fn sort(&mut self)

Sorts the elements in this ‘dictionary’ in ascending order.

fn sort_rev(&mut self)

Sorts the elements in this ‘dictionary’ in descending order.