Struct stack_graphs::paths::SymbolStack

#[repr(C)]
pub struct SymbolStack { /* private fields */ }

A sequence of symbols that describe what we are currently looking for while in the middle of the path-finding algorithm.

Implementations

impl SymbolStack

pub fn is_empty(&self) -> bool

Returns whether this symbol stack is empty.

pub fn len(&self) -> usize

pub fn empty() -> SymbolStack

Returns an empty symbol stack.

pub fn equals(&self, paths: &Paths, other: &SymbolStack) -> bool

pub fn cmp(
    &self,
    graph: &StackGraph,
    paths: &Paths,
    other: &SymbolStack
) -> Ordering

pub fn push_front(&mut self, paths: &mut Paths, scoped_symbol: ScopedSymbol)

Pushes a new ScopedSymbol onto the front of this symbol stack.

pub fn pop_front(&mut self, paths: &Paths) -> Option<ScopedSymbol>

Removes and returns the ScopedSymbol at the front of this symbol stack. If the stack is empty, returns None.

pub fn display<'a>(
    self,
    graph: &'a StackGraph,
    paths: &'a mut Paths
) -> impl Display + 'a

pub fn iter<'a>(
    &'a self,
    paths: &'a Paths
) -> impl Iterator<Item = ScopedSymbol> + 'a

Trait Implementations

impl Clone for SymbolStack

fn clone(&self) -> SymbolStack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<SymbolStack> for sg_symbol_stack

fn from(stack: SymbolStack) -> sg_symbol_stack

Converts to this type from the input type.

impl Niche for SymbolStackwhere
    List<ScopedSymbol>: Niche,

type Output = MaybeUninit<SymbolStack>

The type that is used to store values of Self inside of a ControlledOption. This might be Self itself, if your niche is a valid instance of the type, but which violates some runtime constraint. But if you cannot easily create your niche as an instance of Self, you can use some other type, you can use some other type instead.

fn none() -> Self::Output

Returns the niche value for this type that should be used to represent None for a ControlledOption.

fn is_none(value: &Self::Output) -> bool

Returns whether value is the niche value for this type.

fn into_some(value: Self) -> Self::Output

Transforms a non-niche value of this type into its Output type. When Output is Self, this will be the identity function.

fn from_some(value: Self::Output) -> Self

Transforms a non-niche value of this type from its Output type. When Output is Self, this will be the identity function.

impl Copy for SymbolStack