Struct Tree

pub struct Tree(/* private fields */);

A tree that represents the syntactic structure of a source code file.

Implementations

impl Tree

pub const unsafe fn from_raw(ptr: *mut TSTree) -> Self

Reconstructs a Tree from a raw pointer.

Safety

ptr must be non-null.

pub fn into_raw(self) -> *mut TSTree

Consumes the Tree, returning a raw pointer to the underlying C structure.

impl Tree

pub fn root_node(&self) -> Node<'_>

Get the root node of the syntax tree.

pub fn root_node_with_offset( &self, offset_bytes: usize, offset_extent: Point, ) -> Node<'_>

Get the root node of the syntax tree, but with its position shifted forward by the given offset.

pub fn language(&self) -> LanguageRef<'_>

Get the language that was used to parse the syntax tree.

pub fn edit(&mut self, edit: &InputEdit)

Edit the syntax tree to keep it in sync with source code that has been edited.

You must describe the edit both in terms of byte offsets and in terms of row/column coordinates.

pub fn walk(&self) -> TreeCursor<'_>

Create a new TreeCursor starting from the root of the tree.

pub fn changed_ranges( &self, other: &Self, ) -> impl ExactSizeIterator<Item = Range>

Compare this old edited syntax tree to a new syntax tree representing the same document, returning a sequence of ranges whose syntactic structure has changed.

For this to work correctly, this syntax tree must have been edited such that its ranges match up to the new tree. Generally, you’ll want to call this method right after calling one of the Parser::parse functions. Call it on the old tree that was passed to parse, and pass the new tree that was returned from parse.

pub fn included_ranges(&self) -> Vec<Range>

Get the included ranges that were used to parse the syntax tree.

pub fn print_dot_graph(&self, file: &impl AsRawFd)

Print a graph of the tree to the given file descriptor. The graph is formatted in the DOT language. You may want to pipe this graph directly to a dot(1) process in order to generate SVG output.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Self

Returns a copy 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.

impl Drop for Tree

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Tree

impl Sync for Tree