Enum SyntaxTree 

pub enum SyntaxTree {
    Node {
        kind: String,
        field: Option<String>,
        trivia: bool,
        start: usize,
        end: usize,
        children: Vec<Self>,
        attributes: Option<SyntaxAttributes>,
    },
    Token {
        kind: Option<String>,
        field: Option<String>,
        trivia: bool,
        start: usize,
        end: usize,
        attributes: Option<SyntaxAttributes>,
        text: LeafText,
    },
    Error {
        start: usize,
        end: usize,
        text: LeafText,
        reason: Option<String>,
    },
    Missing {
        kind: Option<String>,
        start: usize,
        end: usize,
        literal: bool,
    },
    Embed {
        language: String,
        start: usize,
        end: usize,
        root: Box<Self>,
    },
}

One node of a concrete syntax tree; offsets are byte offsets into the input.

Variants

Node

A node a rule (or an alias) built.

Fields

kind: String

The node kind.

field: Option<String>

The field the node is captured under.

trivia: bool

Whether the node is trivia (an extra of a rule that builds a node).

start: usize

The first byte.

end: usize

The byte after the last.

children: Vec<Self>

The children, trivia included.

attributes: Option<SyntaxAttributes>

The attributes semantic actions set.

Token

A leaf: a literal, a token rule, an external token or trivia.

Fields

kind: Option<String>

The token kind; None for an anonymous literal.

field: Option<String>

The field the token is captured under.

trivia: bool

Whether the token is trivia (an extra or a channel token).

start: usize

The first byte.

end: usize

The byte after the last.

attributes: Option<SyntaxAttributes>

The attributes semantic actions set.

text: LeafText

The token text.

Error

Input error recovery skipped, or the whole input of a refused parse.

Fields

start: usize

The first byte.

end: usize

The byte after the last.

text: LeafText

The skipped text.

reason: Option<String>

Why the input is an error node, when it is not skipped input.

Missing

A zero-width node error recovery inserted for an absent item.

Fields

kind: Option<String>

The missing rule kind or literal.

start: usize

The offset.

end: usize

The offset again: missing nodes are empty.

literal: bool

Whether kind is a literal.

Embed

A region another language parsed.

Fields

language: String

The embedded language.

start: usize

The first byte.

end: usize

The byte after the last.

root: Box<Self>

The tree of the embedded language.

Implementations

impl SyntaxTree

pub const fn start(&self) -> usize

The first byte of the node.

pub const fn end(&self) -> usize

The byte after the last byte of the node.

pub fn first_recovery(&self) -> Option<&Self>

The first ERROR or MISSING node, in preorder.

pub fn render(&self) -> String

The compact text rendering: (kind {attributes} child ...) for a node, field: before a captured child, the quoted text of an anonymous token, (kind "text") for a named one, ~ before trivia, and (ERROR@S..E "text"), (MISSING@P kind) and (EMBED language@S..E root).

Trait Implementations

impl Clone for SyntaxTree

fn clone(&self) -> SyntaxTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxTree

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

Formats the value using the given formatter.

impl Eq for SyntaxTree

impl PartialEq for SyntaxTree

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SyntaxTree