Struct TreeCursor 

#[repr(transparent)]
pub struct TreeCursor<'tree>(pub TreeCursor<'tree>);

A stateful object for walking a syntax tree efficiently. See raw::TreeCursor

Tuple Fields

0: TreeCursor<'tree>

Implementations

impl<'tree> TreeCursor<'tree>

pub fn wrap_ref<'a>(cursor: &'a TreeCursor<'_>) -> &'a Self

Transmute an immutable reference, since they have the same representation.

pub fn wrap_mut<'a>(cursor: &'a mut TreeCursor<'_>) -> &'a mut Self

Transmute a mutable reference, since they have the same representation.

pub fn node(&self) -> UntypedNode<'tree>

Gets the cursor’s current node

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

Gets the field name of the cursor’s current node

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

Re-initialize the cursor to point to the given node

pub fn goto_first_child(&mut self) -> bool

Move the cursor to the first child of the current node and return true, or return false if the current node has no children

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

Move the cursor to the first child of the current node that extends beyond the given byte offset, and return its index.

Returns None if the current node has no children past that offset.

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

Move the cursor to the first child of the current node that extends beyond the given row and column, and return its index.

Returns None if the current node has no children past that row and column.

pub fn goto_next_sibling(&mut self) -> bool

Move the cursor to the next sibling of the current node and return true, or return false if the current node has no next sibling.

Also returns false if the cursor was initialized or re-initialized to this node, even if it has a sibling.

pub fn goto_parent(&mut self) -> bool

Move the cursor to the parent of the current node and return true, or return false if the current node is a tree root.

Also returns false if the cursor was initialized or re-initialized to this node, even if it has a parent.

Trait Implementations

impl<'tree> Clone for TreeCursor<'tree>

fn clone(&self) -> TreeCursor<'tree>

Returns a duplicate of the value.

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

Performs copy-assignment from source.