Struct gluon_base::scoped_map::ScopedMap

pub struct ScopedMap<K: Eq + Hash, V> { /* fields omitted */ }

A map struct which allows for the introduction of different scopes Introducing a new scope will make it possible to introduce additional variables with names already defined, shadowing the old name After exiting a scope the shadowed variable will again be re introduced

Methods

impl<K: Eq + Hash + Clone, V> ScopedMap<K, V>

pub fn new() -> ScopedMap<K, V>

pub fn num_scopes(&self) -> usize

pub fn enter_scope(&mut self)

Introduces a new scope

pub fn current_scope(
    &self
) -> impl Iterator<Item = (&K, &V)>

Important traits for ExitScopeIter<'a, K, V>

impl<'a, K, V> Iterator for ExitScopeIter<'a, K, V> where
    K: Eq + Hash + Clone,  type Item = (K, V);

pub fn exit_scope(&mut self) -> ExitScopeIter<K, V>

Exits the current scope, returning an iterator over the (key, value) pairs that are removed When ExitScopeIter is dropped any remaining pairs of the scope is removed as well.

pub fn remove<Q>(&mut self, k: &Q) -> bool where
    K: Borrow<Q>,
    Q: Eq + Hash,
    K: Debug,
    V: Debug, 

Removes a previously inserted value from the map.

pub fn in_current_scope<Q>(&self, k: &Q) -> bool where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Returns true if the key has a value declared in the last declared scope

pub fn get<'a, Q: ?Sized>(&'a self, k: &Q) -> Option<&'a V> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Returns a reference to the last inserted value corresponding to the key

pub fn get_all<'a, Q: ?Sized>(&'a self, k: &Q) -> Option<&'a [V]> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Returns a reference to the all inserted value corresponding to the key

pub fn entry(&mut self, key: K) -> Entry<K, V>

pub fn contains_key<'a, Q: ?Sized>(&'a self, k: &Q) -> bool where
    K: Borrow<Q>,
    Q: Eq + Hash, 

pub fn len(&self) -> usize

Returns the number of elements in the container. Shadowed elements are not counted

pub fn full_len(&self) -> usize

Returns the number of elements in the container. Shadowed elements are counted

pub fn is_empty(&self) -> bool

Returns true if this map is empty

pub fn clear(&mut self)

Removes all elements

pub fn swap(&mut self, k: K, v: V) -> Option<V>

Swaps the value stored at key, or inserts it if it is not present

pub fn pop(&mut self, k: &K) -> Option<V>

pub fn get_mut<'a>(&'a mut self, key: &K) -> Option<&'a mut V>

pub fn insert(&mut self, k: K, v: V) -> bool

impl<K: Eq + Hash, V> ScopedMap<K, V>

pub fn iter_mut(&mut self) -> IterMut<K, Vec<V>>

Returns an iterator of the (key, values) pairs inserted in the map

Important traits for Iter<'a, K, V>

impl<'a, K, V> Iterator for Iter<'a, K, V> where
    K: 'a,
    V: 'a,  type Item = (&'a K, &'a V);

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

Trait Implementations

impl<K: Eq + Hash + Clone, V> Extend<(K, V)> for ScopedMap<K, V>

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

Extends a collection with the contents of an iterator.

impl<K: Eq + Hash, V> Default for ScopedMap<K, V>

fn default() -> Self

Returns the "default value" for a type.

impl<K, V> Debug for ScopedMap<K, V> where
    K: Eq + Hash + Debug + Clone,
    V: Debug, 

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

Formats the value using the given formatter.