Struct hayami::SymbolTable

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

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> SymbolTable<K, V>

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

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 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_defs<Q>(&self, key: &Q) -> &[(V, usize)]where
    Q: ?Sized + Hash + Equivalent<K>,

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

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

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

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

Check whether a symbol has a definition

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

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

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

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 popn(&mut self, n: usize)

Pop up to n levels of depth.

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

pub fn clear(&mut self)

Clear this symbol table, preserving it’s capacity

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: Hash + Eq, V, S: BuildHasher> MutSymbolMap<K> for SymbolTable<K, V, S>

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

Get a mutable reference to the definition of a key in the top level of this symbol table

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Value = V

The value stored in this symbol table

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

Get the most recent definition of a key in this symbol table

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

Insert a key/value pair into this symbol table at the current level

fn depth(&self) -> usize

Get the current depth of this symbol table

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

Try to get a mutable reference to the definition of a key in the top level of this symbol table

fn push(&mut self)

Push a level onto this symbol table

fn pop(&mut self)

Pop a level from this symbol table

fn is_empty(&self) -> bool

Whether this symbol table is empty

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

Whether this symbol table contains this key

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

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>