Enum BuildError

pub enum BuildError<T> {
    Incomplete(Sapling<T>),
    MultipleRoots(Sapling<T>),
}

An error returned when attempting to build a Sapling<T>.

The error contains the sapling that failed to build in order to return it to the caller. Otherwise the build function would drop the sapling without returning a resulting Tree<T>.

Variants

Incomplete(Sapling<T>)

The sapling is incomplete and not ready to be built.

It is either empty or there are still unclosed nodes. Use pop_all to close any unclosed nodes and use is_empty to check if th sapling is empty.

MultipleRoots(Sapling<T>)

The sapling contains more than one root node.

When creating nodes on a sapling it is possible to pop the root node and push a second root. Trees however must have a unique root.

To get an iterator over the root nodes build the sapling into a PolyTree<T> using build_polytree.

Trait Implementations

impl<T> Debug for BuildError<T>

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

Formats the value using the given formatter.

impl<T> Display for BuildError<T>

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

Formats the value using the given formatter.

impl<T> Error for BuildError<T>

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

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

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