Enum ErrorKind 

#[non_exhaustive]
pub enum ErrorKind {
    TokenUnexpected(String),
    DescriptionTokenUnexpected(String),
    WhenUnexpected,
    GivenUnexpected,
    ItUnexpected,
    WordUnexpected(String),
    EofUnexpected,
    TreeEmpty,
    TitleMissing,
    TreeRootless,
    CornerNotLastChild,
    TeeLastChild,
}

The type of an error that occurred while building an AST.

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.

TokenUnexpected(String)

This might happen because of an internal bug or the user might have passed an invalid .tree. An example of how this might be an internal bug is if the parser ends up in a state where the current grammar production being applied doesn’t expect this token to occur.

DescriptionTokenUnexpected(String)

Did not expect this token when parsing a description node.

WhenUnexpected

Did not expect this When keyword.

GivenUnexpected

Did not expect this Given keyword.

ItUnexpected

Did not expect this It keyword.

WordUnexpected(String)

Did not expect a Word.

EofUnexpected

Did not expect an end of file.

TreeEmpty

The token stream was empty, so the tree is empty.

TitleMissing

A condition or action with no title was found.

TreeRootless

A tree without a root was found.

CornerNotLastChild

A corner is not the last child.

TeeLastChild

A tee is the last child.

Trait Implementations

impl Clone for ErrorKind

fn clone(&self) -> ErrorKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorKind

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

Formats the value using the given formatter.

impl Display for ErrorKind

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

Formats the value using the given formatter.

impl Eq for ErrorKind

impl Error for ErrorKind

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.

impl FrontendError<ErrorKind> for Error

fn kind(&self) -> &ErrorKind

Return the type of this error.

fn text(&self) -> &str

The original text string in which this error occurred.

fn span(&self) -> &Span

Return the span at which this error occurred.

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

Formats the error message with additional context.

fn notate(&self) -> String

Creates a string with carets (^) pointing at the span where the error occurred.

impl PartialEq for ErrorKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ErrorKind