Struct yak_sitter::Tree

pub struct Tree<Custom = ()> {
    pub custom: Custom,
    /* private fields */
}

Wrapper around tree_sitter::Tree which stores its text, filepath, and extra data that is accessible from any node. It also uses and is used by [tree_sitter_wrapper] wrapper classes.

Fields

custom: Custom

Custom data which you can access behind a shared reference from any Node

Implementations

impl<Custom> Tree<Custom>

pub fn text(&self) -> &str

Get the underlying text. This includes text which isn’t in the Self::included_ranges.

pub fn path(&self) -> Option<&Path>

Get the path the tree is associated with, if any.

The path may be virtual, it’s used for stable node comparison between trees.

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

Get the root node.

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

Create a TreeCursor 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 ) -> impl ExactSizeIterator<Item = Range>

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<Custom: Debug> Debug for Tree<Custom>

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

Formats the value using the given formatter.

impl<'tree, Custom> TextProvider<&'tree str> for &'tree Tree<Custom>

type I = Once<&'tree str>

fn text(&mut self, node: Node<'_>) -> Self::I