outils::tree::generic::error

Enum TreeErrorType

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§

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

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

impl<Ix: Debug> Debug for TreeErrorType<Ix>

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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.