Skip to main content

SyntaxTree

Struct SyntaxTree 

Source
pub struct SyntaxTree { /* private fields */ }
Available on crate feature parser only.
Expand description

A lossless concrete syntax tree for a Source, as produced by the generated parser.

Nodes are referenced using NodeRefs, and are either Node::Rules (with children) or Node::Tokens (leaves). SyntaxTree::ROOT is always a Node::Rule.

Implementations§

Source§

impl SyntaxTree

Source

pub const ROOT: NodeRef = NodeRef::ROOT

The root node of every SyntaxTree.

Source

pub fn source(&self) -> &SourceRef

The source this tree was parsed from.

Source

pub fn get(&self, node: NodeRef) -> Node

Get the Node referenced by the given NodeRef.

Source

pub fn rule(&self, node: NodeRef) -> Option<Rule>

Get the Rule of a node if it’s a rule node.

Source

pub fn token(&self, node: NodeRef) -> Option<Token>

Get the Token type of a node if it’s a token node.

Source

pub fn children(&self, node: NodeRef) -> CstChildren<'_> ⓘ

Get an iterator over the direct children of a node. Token nodes have no children.

Source

pub fn span(&self, node: NodeRef) -> Range<usize> ⓘ

Get the byte range in the source covered by a node.

For rule nodes, this is from the start of their first token to the end of their last. Rule nodes without any tokens (possible when the parser recovers from errors) have an empty range where they would be.

Source

pub fn fragment(&self, node: NodeRef) -> Fragment

Get a Fragment of the source covered by a node (see SyntaxTree::span).

Source

pub fn text(&self, node: NodeRef) -> &str

Get the source text covered by a node (see SyntaxTree::span).

Trait Implementations§

Source§

impl Debug for SyntaxTree

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for SyntaxTree

Source§

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

Print the tree with one node per line, indented by depth. Each line has the rule or token kind and the byte range it covers, and tokens also include their source text.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.