Struct tree_sitter::TreeCursor

pub struct TreeCursor<'cursor>(/* private fields */);

A stateful object for walking a syntax Tree efficiently.

Implementations

impl<'a> TreeCursor<'a>

pub const unsafe fn from_raw(raw: TSTreeCursor) -> Self

Reconstructs a TreeCursor from a raw pointer.

Safety

ptr must be non-null.

pub fn into_raw(self) -> TSTreeCursor

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

impl<'cursor> TreeCursor<'cursor>

pub fn node(&self) -> Node<'cursor>

Get the tree cursor’s current Node.

pub fn field_id(&self) -> Option<NonZeroU16>

Get the numerical field id of this tree cursor’s current node.

See also field_name.

pub fn field_name(&self) -> Option<&'static str>

Get the field name of this tree cursor’s current node.

pub fn depth(&self) -> u32

Get the depth of the cursor’s current node relative to the original node that the cursor was constructed with.

pub fn descendant_index(&self) -> usize

Get the index of the cursor’s current node out of all of the descendants of the original node that the cursor was constructed with

pub fn goto_first_child(&mut self) -> bool

Move this cursor to the first child of its current node.

This returns true if the cursor successfully moved, and returns false if there were no children.

pub fn goto_last_child(&mut self) -> bool

Move this cursor to the last child of its current node.

This returns true if the cursor successfully moved, and returns false if there were no children.

Note that this function may be slower than goto_first_child because it needs to iterate through all the children to compute the child’s position.

pub fn goto_parent(&mut self) -> bool

Move this cursor to the parent of its current node.

This returns true if the cursor successfully moved, and returns false if there was no parent node (the cursor was already on the root node).

pub fn goto_next_sibling(&mut self) -> bool

Move this cursor to the next sibling of its current node.

This returns true if the cursor successfully moved, and returns false if there was no next sibling node.

pub fn goto_descendant(&mut self, descendant_index: usize)

Move the cursor to the node that is the nth descendant of the original node that the cursor was constructed with, where zero represents the original node itself.

pub fn goto_previous_sibling(&mut self) -> bool

Move this cursor to the previous sibling of its current node.

This returns true if the cursor successfully moved, and returns false if there was no previous sibling node.

Note, that this function may be slower than goto_next_sibling due to how node positions are stored. In the worst case, this will need to iterate through all the children upto the previous sibling node to recalculate its position.

pub fn goto_first_child_for_byte(&mut self, index: usize) -> Option<usize>

Move this cursor to the first child of its current node that extends beyond the given byte offset.

This returns the index of the child node if one was found, and returns None if no such child was found.

pub fn goto_first_child_for_point(&mut self, point: Point) -> Option<usize>

Move this cursor to the first child of its current node that extends beyond the given byte offset.

This returns the index of the child node if one was found, and returns None if no such child was found.

pub fn reset(&mut self, node: Node<'cursor>)

Re-initialize this tree cursor to start at the original node that the cursor was constructed with.

pub fn reset_to(&mut self, cursor: &Self)

Re-initialize a tree cursor to the same position as another cursor.

Unlike reset, this will not lose parent information and allows reusing already created cursors.

Trait Implementations

impl Clone for TreeCursor<'_>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for TreeCursor<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for TreeCursor<'_>

impl Sync for TreeCursor<'_>