Enum TokenTree 

pub enum TokenTree {
    Group(TokenGroup),
    Literal(LiteralToken),
    Punct(Punct),
    Ident(IdentToken),
}

One raw M2 token tree.

Variants

Group(TokenGroup)

A delimited group.

Literal(LiteralToken)

A literal.

Punct(Punct)

Punctuation.

Ident(IdentToken)

An identifier or keyword spelling.

Implementations

impl TokenTree

pub fn spelling(&self) -> Option<&str>

Returns the token’s source spelling when it is a flat lexical atom.

Examples found in repository

examples/parse_emit_walkthrough.rs (line 26)

    fn parse(input: &mut ParseStream) -> Result<Self, TokenParseError> {
        let Some(token) = input.next_token() else {
            return Err(TokenParseError::UnexpectedEnd {
                expected: "identifier",
                span: Span::for_text(""),
            });
        };

        let span = token.span();
        match token {
            TokenTree::Ident(identifier) => Ok(Self(identifier)),
            token => Err(TokenParseError::UnexpectedToken {
                expected: "identifier",
                found: token.spelling().unwrap_or("group or trivia").to_owned(),
                span,
            }),
        }
    }

pub fn leading_trivia(&self) -> &LeadingTrivia

Borrows the comments attached before this atom.

pub fn leading_trivia_mut(&mut self) -> &mut LeadingTrivia

Mutably borrows the comments attached before this atom.

pub fn trailing_trivia(&self) -> &TrailingTrivia

Borrows the comments attached after this atom.

pub fn trailing_trivia_mut(&mut self) -> &mut TrailingTrivia

Mutably borrows the comments attached after this atom.

Trait Implementations

impl Clone for TokenTree

fn clone(&self) -> TokenTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenTree

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

Formats the value using the given formatter.

impl Eq for TokenTree

impl FromIterator<TokenTree> for TokenStream

fn from_iter<T: IntoIterator<Item = TokenTree>>(iter: T) -> Self

Creates a value from an iterator.

impl Lex for TokenTree

fn to_tokens(&self, output: &mut TokenStream)

Appends this value’s token trees to output.

fn to_token_stream(&self) -> TokenStream

Emits this value into a fresh token stream.

fn to_m2(&self) -> String

Renders this value as normalized Macaulay2 source.

impl Parse for TokenTree

fn parse(input: &mut ParseStream) -> Result<Self, TokenParseError>

Consumes this value from input.

impl PartialEq for TokenTree

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

Equality operator ==.

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

Inequality operator !=.

impl Spanned for TokenTree

fn try_span(&self) -> Option<Span>

Returns the smallest span covering this value, when its constituents share one source snapshot.

fn span(&self) -> Span

Returns the smallest span covering this value.

fn expect_span(&self) -> Span

Returns this value’s span when one source snapshot covers it.

impl StructuralPartialEq for TokenTree