Struct Tree 

pub struct Tree { /* private fields */ }

A parsed query.

Implementations

impl Tree

pub fn root(&self) -> u32

The root node, which is the rule the parse was started from.

pub fn arena_len(&self) -> usize

How many nodes the tree has, abandoned ones included.

Not the size of the tree that is reachable from the root. It is the size of the arena, which is what the parse cost, and telling the two apart is what the ratio between them is for.

pub fn steps(&self) -> u64

How many nodes of the rule table the matcher went into to produce this.

The one number that says what a parse cost, and the one to watch when the grammar or the filter changes. A parse that is linear in the query does a roughly constant number of these per token; one that is backtracking badly does thousands.

pub fn node(&self, index: u32) -> ParseNode

One node.

pub fn name(&self, index: u32) -> &'static str

The name of the rule a node is.

pub fn children(&self, index: u32) -> Children<'_>

The children of a node, in order.

pub fn text<'a>(&self, index: u32, query: &'a str, tokens: &[Token]) -> &'a str

The text a node covers, given the query and its tokens.

A node that covers no tokens, which is any rule whose body matched nothing, gets the empty string at the point it started rather than a span running backwards.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.