Struct BindingStack

pub struct BindingStack<T> {
    stack: Vec<T>,
}

A stack of values corresponding to nested binders. Each binder introduces an entry in this stack, with the entry as index 0 being the innermost binder. This is indexed by DeBruijnIds. Most methods assume that the stack is non-empty and panic if not.

Fields

stack: Vec<T>

The stack, stored in reverse. We push/pop to the end of the Vec, and the last pushed value (i.e. the end of the vec) is considered index 0.

Implementations

impl<T> BindingStack<T>

pub fn new(x: T) -> Self

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn depth(&self) -> DeBruijnId

pub fn as_bound_var<Id>(&self, var: DeBruijnVar<Id>) -> (DeBruijnId, Id)

Map a bound variable to ids binding depth.

pub fn push(&mut self, x: T)

pub fn pop(&mut self) -> Option<T>

fn real_index(&self, id: DeBruijnId) -> Option<usize>

Helper that computes the real index into self.stack.

pub fn get(&self, id: DeBruijnId) -> Option<&T>

pub fn get_var<'a, Id: Idx, Inner>( &'a self, var: DeBruijnVar<Id>, ) -> Option<&'a Inner::Output>

where T: Borrow<Inner>, Inner: HasVectorOf<Id> + 'a,

pub fn get_mut(&mut self, id: DeBruijnId) -> Option<&mut T>

pub fn iter( &self, ) -> impl Iterator<Item = &T> + DoubleEndedIterator + ExactSizeIterator

Iterate over the binding levels, from the innermost (0) out.

pub fn iter_enumerated( &self, ) -> impl Iterator<Item = (DeBruijnId, &T)> + DoubleEndedIterator + ExactSizeIterator

Iterate over the binding levels, from the innermost (0) out.

pub fn map_ref<'a, U>(&'a self, f: impl FnMut(&'a T) -> U) -> BindingStack<U>

pub fn innermost(&self) -> &T

pub fn innermost_mut(&mut self) -> &mut T

pub fn outermost(&self) -> &T

pub fn outermost_mut(&mut self) -> &mut T

Trait Implementations

impl<T: Clone> Clone for BindingStack<T>

fn clone(&self) -> BindingStack<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BindingStack<T>

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

Formats the value using the given formatter.

impl<T> Default for BindingStack<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Hash> Hash for BindingStack<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<DeBruijnId> for BindingStack<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<DeBruijnId> for BindingStack<T>

fn index_mut(&mut self, id: DeBruijnId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.