Struct TreeError

Source
pub struct TreeError<Ix = DefaultIndexType> { /* private fields */ }
Expand description

Error type that covers the error situations that commonly occur when manipulation tree or forest operations.

TreeError keeps a TreeErrorType describing the error as well as a String that can be used to store a description of the context in which the error has occured.

Implementations§

Source§

impl<Ix> TreeError<Ix>

Source

pub fn invalid_node_index(context: &str, node: NodeIndex<Ix>) -> Self

Construct a new TreeError of type TreeErrorType::InvalidNodeIndex referring to node

Source

pub fn expected_root_node(context: &str, node: NodeIndex<Ix>) -> Self

Construct a new TreeError of type TreeErrorType::ExpectedRootNode referring to node

Source

pub fn expected_non_ancestor_node( context: &str, new_ancestor: NodeIndex<Ix>, new_descendant: NodeIndex<Ix>, ) -> Self

Construct a new TreeError of type TreeErrorType::ExpectedNonAncestorNode referring to new_ancestor and new_descendant.

Source

pub fn other_error(context: &str, msg: &str) -> Self

Construct a new TreeError of type TreeErrorType::OtherType with a custom message msgdescribing the particular error situation.

Trait Implementations§

Source§

impl<Ix: Clone> Clone for TreeError<Ix>

Source§

fn clone(&self) -> TreeError<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 TreeError<Ix>

Source§

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

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

impl Display for TreeError

Source§

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

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

impl Error for TreeError

Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<Ix> UnwindSafe for TreeError<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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.