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.

When Tree-sitter is compiled to WebAssembly, this returns the original language if the tree is being accessed from the same WebAssembly instance that created it. Otherwise, this returns a copy of the language that can be used to inspect the tree but cannot be assigned to a parser.

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

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

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)

Available on crate feature std only.

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 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.

impl Drop for Tree

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Tree

impl Sync for Tree