Struct Token

pub struct Token(pub Loc<Result<Box<dyn Tree>, String>>);

Represents a parse Tree or a parse error, with a Location.

• Token(Loc(Ok(t), location)) represents a parse-tree t. t can be EndOfFile to represent the end of the source code. In this case, the Location is spurious.
• Token(Loc(Err(e), location)) represents an error message e. e can be the empty string to mark the end of incomplete source code. In this case, the Location is spurious.

Tuple Fields

0: Loc<Result<Box<dyn Tree>, String>>

Implementations

impl Token

pub fn new(tree: Box<dyn Tree>, location: impl Into<Location>) -> Self

Constructs a Self from a Tree and its Location.

pub fn new_err( message: impl Into<String>, location: impl Into<Location>, ) -> Self

Constructs a Self from an error message and its Location.

pub fn end_of_file() -> Self

Returns an EndOfFile, to indicate the end of the source code.

pub fn incomplete() -> Self

Returns an empty error message, to indicate incomplete source code.

pub fn location(&self) -> Location

Returns the Location of self.

pub fn result(self) -> Result<Box<dyn Tree>, String>

Throws away the location.

pub fn result_ref(&self) -> &Result<Box<dyn Tree>, String>

Throws away the location.

pub fn is<T: Tree>(&self) -> bool

Tests whether self is a T.

pub fn is_incomplete(&self) -> bool

Tests whether self marks the end of incomplete source code.

pub fn unwrap<T: Tree>(self) -> T

Discard the Location, panic on Err, and panic if the payload is not of type T.

This is useful in test code.

pub fn unwrap_err(self) -> String

Discard the Location, panic on Ok, return the error message.

This is useful in test code.

Trait Implementations

impl Debug for Token

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

Formats the value using the given formatter.

impl<T: Tree + PartialEq> PartialEq<T> for Token

fn eq(&self, other: &T) -> 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.