Enum DepthFirstSequenceError

Source
pub enum DepthFirstSequenceError {
    NonZeroRootDepth,
    DepthIncreaseGreaterThanOne {
        depth: usize,
        succeeding_depth: usize,
    },
}
Expand description

A depth first sequence, or DepthFirstSequence is simply a sequence of (usize, T) tuples corresponding to (depth, value) pairs of nodes of a tree which are ordered by the depth-first traversal order.

Therefore, not all IntoIterator<Item = (usize, T)> types satisfy the depth-first sequence requirement. The invalid sequences are represented by the DepthFirstSequenceError type.

Variants§

§

NonZeroRootDepth

The first element of the depth-first sequence must be the root with depth 0. Therefore, any sequence with a first element having a non-zero depth leads to this error.

Note that empty sequences are valid and represent an empty tree.

§

DepthIncreaseGreaterThanOne

While traversing a tree in depth first order, we

  • either move one level down to access the child (depth = previous depth + 1)
  • or stay at the same level to access the sibling to the right (depth = previous depth)
  • or move up and then right to access the next child of an ancestor (depth < previous depth)

This list represents valid depth transition. However, we never

  • move n > 1 level down (depth > previous depth + 1)

This leaves a gap in the depth-first traversal, and hance, is the invalid case that this error variant represents.

Fields

§depth: usize

Depth of the node where the error is observed.

§succeeding_depth: usize

Depth succeeding the depth which is at least two more than the previous.

Trait Implementations§

Source§

impl Clone for DepthFirstSequenceError

Source§

fn clone(&self) -> DepthFirstSequenceError

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DepthFirstSequenceError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for DepthFirstSequenceError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for DepthFirstSequenceError

Source§

impl StructuralPartialEq for DepthFirstSequenceError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> SoM<T> for T

Source§

fn get_ref(&self) -> &T

Returns a reference to self.
Source§

fn get_mut(&mut self) -> &mut T

Returns a mutable reference to self.
Source§

impl<T> SoR<T> for T

Source§

fn get_ref(&self) -> &T

Returns a reference to self.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.