Enum TreeErrorType

Source
pub enum TreeErrorType<Ix = DefaultIndexType> {
    InvalidNodeIndex {
        node: NodeIndex<Ix>,
    },
    ExpectedRootNode {
        node: NodeIndex<Ix>,
    },
    ExpectedNonAncestorNode {
        new_ancestor: NodeIndex<Ix>,
        new_descendant: NodeIndex<Ix>,
    },
    OtherError {
        msg: String,
    },
}
Expand description

Enum to refer to error situations that commonly occur in forest operations.

Variants§

§

InvalidNodeIndex

A node index was passed to an operation but did not refer to a valid node.

Fields

§node: NodeIndex<Ix>

The node index that was passed to the operation.

§

ExpectedRootNode

An operation is only defined for root nodes, but an invalid node index or a node index referring to a non-tree node was passed to the operation.

Fields

§node: NodeIndex<Ix>

The node index that was passed to operation.

§

ExpectedNonAncestorNode

An operation is only defined for forest nodes that are not part of the same forest tree, but the nodes passed to this operation are already in a ancestor/descendant relation.

Fields

§new_ancestor: NodeIndex<Ix>

The node that was passed to the operation as the new ancestor

§new_descendant: NodeIndex<Ix>

The node that was passed to the operation as the new descendant

§

OtherError

Summary error type, which can be used in other error situations which do not have a direct relation to defined operations of a forest.

Fields

§msg: String

Description of the particular error situation.

Trait Implementations§

Source§

impl<Ix: Clone> Clone for TreeErrorType<Ix>

Source§

fn clone(&self) -> TreeErrorType<Ix>

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<Ix: Debug> Debug for TreeErrorType<Ix>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Ix> Freeze for TreeErrorType<Ix>
where Ix: Freeze,

§

impl<Ix> RefUnwindSafe for TreeErrorType<Ix>
where Ix: RefUnwindSafe,

§

impl<Ix> Send for TreeErrorType<Ix>
where Ix: Send,

§

impl<Ix> Sync for TreeErrorType<Ix>
where Ix: Sync,

§

impl<Ix> Unpin for TreeErrorType<Ix>
where Ix: Unpin,

§

impl<Ix> UnwindSafe for TreeErrorType<Ix>
where Ix: UnwindSafe,

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> 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.