Struct TreeError

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

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

impl<Ix> TreeError<Ix>

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

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

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

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

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.

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Ix: Debug> Debug for TreeError<Ix>

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

Formats the value using the given formatter.

impl Display for TreeError

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

Formats the value using the given formatter.

impl Error for TreeError

fn description(&self) -> &str

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

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

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

Returns the lower-level source of this error, if any.

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.