Struct quickscope::ScopeMap

pub struct ScopeMap<K, V, S: BuildHasher = RandomState> { /* fields omitted */ }

A layered hash map for representing scoped variables and their values.

Implementations

impl<K, V> ScopeMap<K, V, RandomState>

pub fn new() -> ScopeMap<K, V, RandomState>

Creates an empty ScopeMap with a default hasher and capacity.

pub fn with_capacity(capacity: usize) -> ScopeMap<K, V, RandomState>

Creates an empty ScopeMap with a default hasher and the specified capacity.

impl<K, V, S: BuildHasher> ScopeMap<K, V, S>

pub fn with_hasher(hash_builder: S) -> Self

Creates an empty ScopeMap with the specified hasher and a default capacity.

pub fn with_capacity_and_hasher(capacity: usize, hash_builder: S) -> Self

Creates an empty ScopeMap with the specified hasher and capacity.

pub fn capacity(&self) -> usize

Gets the number of elements the map can hold without reallocating.

pub fn is_empty(&self) -> bool

Returns true if the map is empty.

pub fn len(&self) -> usize

Gets the number of unique keys in the map.

pub fn depth(&self) -> usize

Gets the number of layers in the map.

impl<K, V, S> ScopeMap<K, V, S> where
    S: BuildHasher, 

pub fn push_layer(&mut self)

Adds a new, empty layer.

Computes in O(1) time.

pub fn pop_layer(&mut self) -> bool

Removes the topmost layer (if it isn't the bottom layer) and all associated keys/values. Returns true if a layer was removed.

Computes in O(n) time in relation to the number of keys stored in the removed layer.

impl<K: Eq + Hash, V, S: BuildHasher> ScopeMap<K, V, S>

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

Returns true if the map contains the specified key in any layer.

Computes in O(1) time.

pub fn contains_key_at_top<Q: ?Sized>(&self, key: &Q) -> bool where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Returns true if the map contains the specified key at the top layer.

Computes in O(1) time.

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

Gets a reference to the topmost value associated with a key.

Computes in O(1) time.

pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut V> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Gets a mutable reference to the topmost value associated with a key.

Computes in O(1) time.

pub fn get_parent<Q: ?Sized>(&self, key: &Q, skip_count: usize) -> Option<&V> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Gets a reference to a value skip_count layers below the topmost value associated with a key.

Computes in O(n) time (worst-case) in relation to skip_count.

pub fn get_parent_mut<Q: ?Sized>(
    &mut self,
    key: &Q,
    skip_count: usize
) -> Option<&mut V> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Gets a mutable reference to a value skip_count layers below the topmost value associated with a key.

Computes in O(n) time (worst-case) in relation to skip_count.

pub fn depth_of<Q: ?Sized>(&self, key: &Q) -> Option<usize> where
    K: Borrow<Q>,
    Q: Eq + Hash, 

Gets the depth of the specified key (i.e. how many layers down the key is). A depth of 0 means that the current layer contains the key.

Returns None if the key does not exist.

Computes in O(n) time (worst-case) in relation to layer count.

pub fn define(&mut self, key: K, value: V)

Adds the specified entry to the topmost layer.

pub fn delete(&mut self, key: K) -> bool

Removes the entry with the specified key from the topmost layer.

pub fn clear_top(&mut self)

Removes all entries in the topmost layer.

pub fn clear_all(&mut self)

Removes all elements and additional layers.

Trait Implementations

impl<K: Clone, V: Clone, S: Clone + BuildHasher> Clone for ScopeMap<K, V, S>

fn clone(&self) -> ScopeMap<K, V, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, S: Default + BuildHasher> Default for ScopeMap<K, V, S>

fn default() -> Self

Creates a new ScopeMap with the default configuration.

impl<K, Q: ?Sized, V, S, '_> Index<&'_ Q> for ScopeMap<K, V, S> where
    K: Eq + Hash + Borrow<Q>,
    Q: Eq + Hash,
    S: BuildHasher, 

type Output = V

The returned type after indexing.

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

Returns a reference to the value associated with the provided key.

Panics

Panics if the key does not exist in the ScopeMap.