Enum CstNode 

pub enum CstNode {
    List {
        tag: Option<String>,
        open: Option<String>,
        close: Option<String>,
        children: Vec<CstNode>,
    },
    Token {
        tag: Option<String>,
        text: String,
    },
    Trivia {
        tag: Option<String>,
        text: String,
    },
}

A CST node. Three kinds: List (with optional open/close delimiters), Token (significant lexeme), Trivia (whitespace or comment).

Variants

List

A list node with an optional dialect tag and optional open/close delimiter strings (e.g. (, )).

Fields

tag: Option<String>

open: Option<String>

close: Option<String>

children: Vec<CstNode>

Token

A non-trivia lexeme. text holds the original source bytes.

Fields

tag: Option<String>

text: String

Trivia

Whitespace or comment trivia. text holds the original source bytes.

Fields

tag: Option<String>

text: String

Implementations

impl CstNode

pub fn list(tag: impl Into<String>, children: Vec<CstNode>) -> Self

Construct a List node.

pub fn list_with_delims( tag: Option<String>, open: Option<String>, close: Option<String>, children: Vec<CstNode>, ) -> Self

Construct an untagged List node with custom open/close delimiters.

pub fn token(text: impl Into<String>, tag: Option<&str>) -> Self

Construct a Token leaf.

pub fn trivia(text: impl Into<String>, tag: Option<&str>) -> Self

Construct a Trivia leaf.

pub fn is_list(&self) -> bool

True if this node is a list.

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

The dialect tag, if any.

pub fn text(&self) -> &str

The textual content of a leaf node. Returns "" for lists.

pub fn leaves(&self) -> Vec<&CstNode>

Iterate every leaf (token/trivia) of this subtree in document order.

Trait Implementations

impl Clone for CstNode

fn clone(&self) -> CstNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CstNode

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

Formats the value using the given formatter.

impl PartialEq for CstNode

fn eq(&self, other: &CstNode) -> 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 Eq for CstNode

impl StructuralPartialEq for CstNode