Struct stack_graphs::paths::PathEdgeList

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

The edges in a path keep track of precedence information so that we can correctly handle shadowed definitions.

Implementations

impl PathEdgeList

pub fn is_empty(&self) -> bool

Returns whether this edge list is empty.

pub fn len(&self) -> usize

pub fn have_reversal(&self, paths: &Paths) -> bool

Returns whether this edge list is iterable in both directions without needing mutable access to the arena.

pub fn empty() -> PathEdgeList

Returns an empty edge list.

pub fn push_front(&mut self, paths: &mut Paths, edge: PathEdge)

Pushes a new edge onto the front of this edge list.

pub fn push_back(&mut self, paths: &mut Paths, edge: PathEdge)

Pushes a new edge onto the back of this edge list.

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

Removes and returns the edge at the front of this edge list. If the list is empty, returns None.

pub fn pop_back(&mut self, paths: &mut Paths) -> Option<PathEdge>

Removes and returns the edge at the back of this edge list. If the list is empty, returns None.

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

pub fn shadows(self, paths: &mut Paths, other: PathEdgeList) -> bool

Returns whether one edge list shadows another. Note that shadowing is not commutative — if path A shadows path B, the reverse is not true.

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

pub fn cmp(self, paths: &mut Paths, other: PathEdgeList) -> Ordering

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

Returns an iterator over the contents of this edge list.

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

Returns an iterator over the contents of this edge list, with no guarantee about the ordering of the elements.

Trait Implementations

impl Clone for PathEdgeList

fn clone(&self) -> PathEdgeList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<PathEdgeList> for sg_path_edge_list

fn from(edges: PathEdgeList) -> sg_path_edge_list

Converts to this type from the input type.

impl Niche for PathEdgeListwhere
    Deque<PathEdge>: Niche,

type Output = MaybeUninit<PathEdgeList>

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 PathEdgeList