Enum Position

pub enum Position<B, I> {
    Attached(AttachedPosition<B, I>),
    Detached(DetachedPosition<B, I>),
}

Descripion of a position in a tree

Tthe position can either be attached (targetting a node) or detached (outside of the tree). Positions are described by an absolute Path that cannot move above the tree root.

Variants

Attached(AttachedPosition<B, I>)

The position is targetting a node

Detached(DetachedPosition<B, I>)

The position is leaving the tree

Implementations

impl<B, I> Position<B, I>

pub fn new_detached() -> Self

pub fn new_attached(root: I) -> Self

pub fn from(path: Path<B>, idxs: Path<I>) -> Self

pub fn move_up(&mut self, up: usize) -> Option<usize>

pub fn parent(&self) -> Option<(Option<&B>, Option<&I>)>

pub fn is_attached(&self) -> bool

pub fn attached_mut(&mut self) -> Option<&mut AttachedPosition<B, I>>

pub fn detached_mut(&mut self) -> Option<&mut DetachedPosition<B, I>>

pub fn attached(&self) -> Option<&AttachedPosition<B, I>>

pub fn detached(&self) -> Option<&DetachedPosition<B, I>>

pub fn unwrap_detached(self) -> DetachedPosition<B, I>

pub fn unwrap_attached(self) -> AttachedPosition<B, I>

pub fn at(&self) -> Option<&I>

pub fn path(&self) -> &Path<B>

pub fn idxs(&self) -> &Path<I>

pub fn at_branch(&self) -> Option<&B>

Trait Implementations

impl<B: Clone, I: Clone> Clone for Position<B, I>

fn clone(&self) -> Position<B, I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug, I: Debug> Debug for Position<B, I>

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

Formats the value using the given formatter.