Struct PathStack

pub struct PathStack(/* private fields */);

A stack that stores sequences of LabelNameId as a single array

Internally, it is a flattened array of paths. Each sequence is made of parts represented by an id, and sequences are separated by PATH_SEPARATOR.

Parts are in the reverse order of insertion, to avoid lazily popping without peeking.

use swh_graph::collections::PathStack;
use swh_graph::labels::LabelNameId;

let path1 = [LabelNameId(0), LabelNameId(10)];
let path2 = [LabelNameId(1)];

let mut stack = PathStack::new();
stack.push(path1);
stack.push(path2);
assert_eq!(stack.pop().unwrap().collect::<Vec<_>>(), path2);
assert_eq!(stack.pop().unwrap().collect::<Vec<_>>(), path1);
assert!(stack.pop().is_none());

Implementations

impl PathStack

pub fn new() -> PathStack

pub fn with_capacity(capacity: usize) -> PathStack

Creates a new empty PathStack pre-allocated for this many paths plus path parts.

pub fn push<Iter: IntoIterator<Item = LabelNameId>>(&mut self, path: Iter)

where <Iter as IntoIterator>::IntoIter: DoubleEndedIterator,

Adds a path to this stack

Panics

If any of the LabelNameId path parts was manually built from u64::MAX.

pub fn push_filename(&mut self, item: LabelNameId)

Adds a path part to the last path on this stack

Panics

If the LabelNameId path parts was manually built from u64::MAX.

pub fn pop(&mut self) -> Option<PopPathStack<'_>>

Removes the last path of this stack

Returns an iterator that pops parts from the part as the iterator is consumed. It is safe to drop the iterator without consuming it.

Trait Implementations

impl Clone for PathStack

fn clone(&self) -> PathStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathStack

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

Formats the value using the given formatter.

impl Default for PathStack

fn default() -> PathStack

Returns the “default value” for a type.

impl PartialEq for PathStack

fn eq(&self, other: &PathStack) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

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

impl Eq for PathStack

impl StructuralPartialEq for PathStack