Struct quickscope::ScopeSet

pub struct ScopeSet<T, S: BuildHasher = RandomState> { /* private fields */ }

A layered hash set for representing the scopes of variables.

Implementations

impl<T> ScopeSet<T, RandomState>

pub fn new() -> Self

Creates an empty ScopeSet with a default hasher and capacity.

pub fn with_capacity(capacity: usize) -> Self

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

impl<T, S: BuildHasher> ScopeSet<T, S>

pub fn with_hasher(hash_builder: S) -> Self

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

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

Creates an empty ScopeSet with the specified capacity and hasher.

impl<T, S: BuildHasher> ScopeSet<T, S>

pub fn is_empty(&self) -> bool

Returns true is the set is empty.

pub fn capacity(&self) -> usize

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

pub fn len(&self) -> usize

Gets the number of unique keys in the set.

pub fn depth(&self) -> usize

Gets the number of layers in the set.

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. Returns true if the layer was removed.

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

impl<T: Eq + Hash, S: BuildHasher> ScopeSet<T, S>

pub fn clear_all(&mut self)

Removes all entries and additional layers.

pub fn clear_top(&mut self)

Removes all keys in the topmost layer.

pub fn define(&mut self, key: T)

Adds the specified key to the topmost layer.

pub fn define_parent(&mut self, key: T, min_depth: usize)

Adds the specified key to the layer min_depth layers below the top layer. Saturates to base layer.

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

Removes the specified key from the topmost layer and returns it.

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

Returns true if any layer contains the specified key.

Computes in O(1) time.

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

Returns true if the topmost layer contains the specified key. Computes in O(1) time.

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

Gets the depth of the specified key (i.e. how many layers down from the top that the key first appears). A depth of 0 refers to the top layer.

Returns None if the key does not exist.

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

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

Gets the depth of the specified key (i.e. how many layers down from the top that the key first appears), but ignores a maximum number of layers from the top equal to min_depth. Saturates to base layer.

Returns None if the key does not exist.

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

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

Gets the height of the specified key (i.e. how many layers up from the bottom that the key last appears). A height of 0 refers to the bottom layer.

Returns None if the key does not exist.

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

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

Gets the height of the specified key (i.e. how many layers up from the bottom that the key last appears), but ignores a maximum number of layers from the top equal to min_depth. A height of 0 refers to the bottom layer. Saturates to base layer.

Returns None if the key does not exist.

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

pub fn iter(&self) -> impl Iterator<Item = &T>

Iterates over the keys in arbitrary order.

The iterator element type is &'a T.

pub fn iter_top(&self) -> impl Iterator<Item = &T>

Iterates over the top-level keys in arbitrary order.

The iterator element type is &'a T.

Trait Implementations

impl<T: Clone, S: Clone + BuildHasher> Clone for ScopeSet<T, S>

fn clone(&self) -> ScopeSet<T, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S: Default + BuildHasher> Default for ScopeSet<T, S>

fn default() -> Self

Creates a new ScopeSet with the default configuration.