Trait toad_common::map::Map

pub trait Map<K: Ord + Eq + Hash, V>: Default + GetSize + Reserve + Extend<(K, V)> + FromIterator<(K, V)> + IntoIterator<Item = (K, V)> {
    fn insert(&mut self, key: K, val: V) -> Result<(), InsertError<V>>;
    fn remove<Q: Hash + Eq + Ord>(&mut self, key: &Q) -> Option<V>
    where
        K: Borrow<Q>;
    fn get<'a, Q: Hash + Eq + Ord>(&'a self, key: &Q) -> Option<&'a V>
    where
        K: Borrow<Q> + 'a;
    fn get_mut<'a, Q: Hash + Eq + Ord>(
        &'a mut self,
        key: &Q
    ) -> Option<&'a mut V>
    where
        K: Borrow<Q> + 'a;
    fn iter(&self) -> Iter<'_, K, V>;
    fn iter_mut(&mut self) -> IterMut<'_, K, V>;

    fn has<Q: Hash + Eq + Ord>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
    { ... }
}

An collection of key-value pairs

Provided implementations

• HashMap<K, V>
• tinyvec::ArrayVec<(K, V)>
• Vec<(K, V)>

Requirements

• Default for creating the map
• Extend for adding new entries to the map
• Reserve for reserving space ahead of time
• GetSize for bound checks, empty checks, and accessing the length
• FromIterator for collecting into the map
• IntoIterator for iterating and destroying the map

Required Methods

fn insert(&mut self, key: K, val: V) -> Result<(), InsertError<V>>

See [HashMap.insert]

fn remove<Q: Hash + Eq + Ord>(&mut self, key: &Q) -> Option<V>where
    K: Borrow<Q>,

See [HashMap.remove]

fn get<'a, Q: Hash + Eq + Ord>(&'a self, key: &Q) -> Option<&'a V>where
    K: Borrow<Q> + 'a,

See [HashMap.get]

fn get_mut<'a, Q: Hash + Eq + Ord>(&'a mut self, key: &Q) -> Option<&'a mut V>where
    K: Borrow<Q> + 'a,

See [HashMap.get_mut]

fn iter(&self) -> Iter<'_, K, V>

See [HashMap.iter]

fn iter_mut(&mut self) -> IterMut<'_, K, V>

See [HashMap.iter_mut]

Provided Methods

fn has<Q: Hash + Eq + Ord>(&self, key: &Q) -> boolwhere
    K: Borrow<Q>,

See [HashMap.contains_key]

Implementations on Foreign Types

impl<K: Eq + Hash + Ord, V> Map<K, V> for BTreeMap<K, V>

fn insert(&mut self, key: K, val: V) -> Result<(), InsertError<V>>

fn remove<Q: Ord>(&mut self, key: &Q) -> Option<V>where
    K: Borrow<Q>,

fn get<'a, Q: Hash + Eq + Ord>(&'a self, key: &Q) -> Option<&'a V>where
    K: Borrow<Q> + 'a,

fn get_mut<'a, Q: Hash + Eq + Ord>(&'a mut self, key: &Q) -> Option<&'a mut V>where
    K: Borrow<Q> + 'a,

fn iter(&self) -> Iter<'_, K, V>

fn iter_mut(&mut self) -> IterMut<'_, K, V>

impl<K: Eq + Hash + Ord, V> Map<K, V> for HashMap<K, V>

fn iter(&self) -> Iter<'_, K, V>

fn iter_mut(&mut self) -> IterMut<'_, K, V>

fn get<'a, Q: Hash + Eq + Ord>(&'a self, key: &Q) -> Option<&'a V>where
    K: Borrow<Q> + 'a,

fn get_mut<'a, Q: Hash + Eq + Ord>(&'a mut self, key: &Q) -> Option<&'a mut V>where
    K: Borrow<Q> + 'a,

fn insert(&mut self, key: K, val: V) -> Result<(), InsertError<V>>

fn remove<Q: Hash + Eq + Ord>(&mut self, key: &Q) -> Option<V>where
    K: Borrow<Q>,

Implementors

impl<T: Array<Item = (K, V)>, K: Eq + Hash + Ord, V> Map<K, V> for T