Skip to main content

Cst

Struct Cst 

Source
pub struct Cst<'a> { /* private fields */ }
Available on crate feature parser only.
Expand description

A concrete syntax tree (CST) type.

Nodes are laid out linearly in memory. Spans for tokens are directly stored in the spans vector. Spans for rule nodes are calculated based on their contained token nodes.

§Example

This syntax tree

foo
  bar
    A
    B
  C

will have the following nodes vector.

[
   Node::Rule(Rule::Foo, 4),
   Node::Rule(Rule::Bar, 2),
   Node::Token(Token::A, 0),
   Node::Token(Token::B, 1),
   Node::Token(Token::C, 2),
]

Implementations§

Source§

impl<'a> Cst<'a>

Source

pub fn source(&self) -> &'a str

Source

pub fn into_data(self) -> CstData

Source

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

Returns an iterator over the children of the node referenced by node_ref.

Source

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

Returns the node referenced by node_ref.

Source

pub fn span(&self, node_ref: NodeRef) -> Span

Returns the span for the node referenced by node_ref.

For rules the span is calculated based on the first and last token. If there are no tokens the function returns None.

Source

pub fn match_token( &self, node_ref: NodeRef, matched_token: Token, ) -> Option<(&'a str, Span)>

Returns the slice and span of the node referenced by node_ref if it matches matched_token.

Source

pub fn match_rule(&self, node_ref: NodeRef, matched_rule: Rule) -> bool

Checks if the node referenced by node_ref matches matched_rule.

Source

pub fn span_text(&self, span_idx: CstIndex) -> &'a str

Returns the source text corresponding to the span index

Trait Implementations§

Source§

impl<'a> Debug for Cst<'a>

Source§

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

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

impl Display for Cst<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Forget for Cst<'a>

§

impl<'a> Freeze for Cst<'a>

§

impl<'a> RefUnwindSafe for Cst<'a>

§

impl<'a> Send for Cst<'a>

§

impl<'a> Sync for Cst<'a>

§

impl<'a> Unpin for Cst<'a>

§

impl<'a> UnsafeUnpin for Cst<'a>

§

impl<'a> UnwindSafe for Cst<'a>

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.