Struct Tree 

#[repr(transparent)]
pub struct Tree<Root>(pub Tree, _)
where
    Root: Node<'static>;

Tuple Fields

0: Tree

Implementations

impl<Root> Tree<Root>

where Root: Node<'static>,

pub fn wrap(tree: Tree) -> Tree<Root>

Convert a tree-sitter tree into a typed tree by specifying the correct root node type.

This will succeed even if Root is not the language’s root node, because root_node checks that the root node is the correct type.

pub fn wrap_ref(tree: &Tree) -> &Tree<Root>

Version of wrap for an immutable reference.

pub fn wrap_mut(tree: &mut Tree) -> &mut Tree<Root>

Version of wrap for a mutable reference.

pub fn root_node( &self, ) -> Result<<Root as Node<'static>>::WithLifetime<'_>, IncorrectKind<'_>>

Get the root node of this tree.

Returns Err if the root is the wrong type, which may happen even if the language is correct if the entire tree is an error node.

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

Create a cursor starting at the root node

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

Get the included ranges used to parse the tree

pub fn changed_ranges(&self, other: &Tree<Root>) -> impl ExactSizeIterator

Get the changed ranges. See tree_sitter::Tree::changed_ranges

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

Get the language used to parse the tree.

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

Print a dot graph of the tree to the given file. See tree_sitter::Tree::print_dot_graph

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

Edit the tree. See tree_sitter::Tree::edit

Trait Implementations

impl<Root> Clone for Tree<Root>

where Root: Clone + Node<'static>,

fn clone(&self) -> Tree<Root>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Root> Debug for Tree<Root>

where Root: Debug + Node<'static>,

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

Formats the value using the given formatter.