Struct hayami::SymbolTable

pub struct SymbolTable<K: Hash + Eq, V, S: BuildHasher = RandomState> { /* fields omitted */ }

A simple, generic symbol table.

Behaves like a stack of HashMaps, where you can only insert symbols into the top map with insert. When a symbol is looked up with get, first the top map is checked, then the map under it, etc., with the first match found returned. This is implemented more efficiently using an IndexMap. get_full does the same, but returns the depth at which the symbol was found.

Implementations

impl<K: Hash + Eq, V, S: BuildHasher> SymbolTable<K, V, S> where
    IndexMap<K, Vec<(V, usize)>, S>: Default, 

pub fn new() -> SymbolTable<K, V, S>

Create a new, empty symbol table

impl<K: Hash + Eq, V, S: BuildHasher> SymbolTable<K, V, S> where
    S: Default, 

pub fn with_capacity(n: usize) -> SymbolTable<K, V, S>

Create a symbol table with a given capacity

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

pub fn with_hasher(hash_builder: S) -> SymbolTable<K, V, S>

Create a symbol table with a given hasher

pub fn with_capacity_and_hasher(
    n: usize,
    hash_builder: S
) -> SymbolTable<K, V, S>

Create a symbol table with a given capacity and hasher

pub fn depth(&self) -> usize

Get the current depth

pub fn insert(&mut self, key: K, value: V) -> Option<V>

Register a given symbol at the current depth, returning the current definition at the current depth, if any.

pub fn try_insert(&mut self, key: K, value: V) -> Result<(), V>

Try to register a given symbol at the current depth. Fail if the symbol is already defined

pub fn get_full<Q: ?Sized>(&self, key: &Q) -> Option<(&V, usize)> where
    Q: Hash + Equivalent<K>, 

Get the definition of a current symbol, along with its depth, if any

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

Get the definition of a symbol

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

Check whether a symbol has a definition

pub fn get_full_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<(&mut V, usize)> where
    Q: Hash + Equivalent<K>, 

Mutably get the definition of a current symbol, along with its depth, if any

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

Try to mutably get the definition of a current symbol at the current depth

pub fn jump(&mut self, depth: usize)

Get the mutable definition of a current symbol, along with its depth, if any Jump to a given depth, removing obsolete definitions. Return the number of keys and definitions removed, as well as keys touched, if any.

pub fn push(&mut self)

Add a level of depth

pub fn popn(&mut self, n: usize)

Pop up to n levels of depth.

pub fn pop(&mut self)

Try to remove a level of depth. Does nothing if depth = 0

pub fn is_empty(&self) -> bool

Check whether a symbol table is empty

pub fn reserve(&mut self, additional: usize)

Reserve space for at least additional symbols in this symbol table

pub fn capacity(&self) -> usize

Get the capacity of this symbol table

Trait Implementations

impl<K: Clone + Hash + Eq, V: Clone, S: Clone + BuildHasher> Clone for SymbolTable<K, V, S>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Hash + Eq + Debug, V: Debug, S: BuildHasher> Debug for SymbolTable<K, V, S>

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

Formats the value using the given formatter.

impl<K: Hash + Eq, V, S: BuildHasher> Default for SymbolTable<K, V, S> where
    IndexMap<K, Vec<(V, usize)>, S>: Default, 

fn default() -> SymbolTable<K, V, S>

Returns the "default value" for a type.

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

impl<K: PartialEq + Hash + Eq, V: PartialEq, S: PartialEq + BuildHasher> PartialEq<SymbolTable<K, V, S>> for SymbolTable<K, V, S>

fn eq(&self, other: &SymbolTable<K, V, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SymbolTable<K, V, S>) -> bool

This method tests for !=.

impl<K: Hash + Eq, V, S: BuildHasher> StructuralEq for SymbolTable<K, V, S>

impl<K: Hash + Eq, V, S: BuildHasher> StructuralPartialEq for SymbolTable<K, V, S>