Enum syntree::TreeError

#[non_exhaustive]
pub enum TreeError {
    CloseError,
    BuildError,
    CloseAtError,
    CursorOverflow,
    IdOverflow,
}

Errors raised while building a tree.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CloseError

Error raised by TreeBuilder::close if there currently is no node being built.

Examples

use syntree::{TreeBuilder, TreeError};

let mut tree = TreeBuilder::new();

tree.open("root")?;
tree.close()?;

// Syntax::Root and Syntax::Child is left open.
assert_eq!(tree.close(), Err(TreeError::CloseError));

BuildError

Error raised by TreeBuilder::build if the tree isn’t correctly balanced.

Examples

use syntree::{TreeBuilder, TreeError};

let mut tree = TreeBuilder::new();

tree.open("number")?;
tree.token("lit", 3)?;
tree.close()?;

tree.open("number")?;

// Syntax::Number is left open.
assert_eq!(tree.build(), Err(TreeError::BuildError));

CloseAtError

Error raised by TreeBuilder::close_at if we’re not trying to close at a sibling node.

Examples

use syntree::{TreeBuilder, TreeError};

let mut tree = TreeBuilder::new();

let c = tree.checkpoint()?;

tree.open("child")?;
tree.token("token", 3)?;

let result = tree.close_at(c, "operation");
assert_eq!(result, Err(TreeError::CloseAtError));

CursorOverflow

Cursor overflowed.

This only happens under extreme circumstances or if a feature is enabled which narrows the width of an identifier to the degree that this error is easier to accomplish.

IdOverflow

Identifier overflowed.

This only happens under extreme circumstances or if a feature is enabled which narrows the width of an identifier to the degree that this error is easier to accomplish.

Trait Implementations

impl Clone for TreeError

fn clone(&self) -> TreeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreeError

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 source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl PartialEq<TreeError> for TreeError

fn eq(&self, other: &TreeError) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for TreeError

impl Eq for TreeError

impl StructuralEq for TreeError

impl StructuralPartialEq for TreeError