Type Alias NodeResult 

pub type NodeResult<'tree, T> = Result<T, IncorrectKind<'tree>>;

Result of attempting to wrap a node

Aliased Type

pub enum NodeResult<'tree, T> {
    Ok(T),
    Err(IncorrectKind<'tree>),
}

Variants

Ok(T)

Contains the success value

Err(IncorrectKind<'tree>)

Contains the error value

Trait Implementations

impl<'tree, T: Node<'tree>> Node<'tree> for NodeResult<'tree, T>

const KIND: &'static str = "{result}"

Kind of nodes this wraps.

type WithLifetime<'a> = Result<<T as Node<'tree>>::WithLifetime<'a>, IncorrectKind<'a>>

The same type, but with a different lifetime.

fn try_from_raw(node: Node<'tree>) -> NodeResult<'tree, Self>

Check that the tree-sitter node is the correct kind, and if it is, wrap.

unsafe fn from_raw_unchecked(node: Node<'tree>) -> Self

Assume that tree-sitter node is the correct kind and wrap.

fn raw(&self) -> &Node<'tree>

The wrapped tree-sitter node.

fn raw_mut(&mut self) -> &mut Node<'tree>

The wrapped tree-sitter node (mutable reference, rarely needed).

fn into_raw(self) -> Node<'tree>

Destruct into the wrapped tree-sitter node.

fn upcast(self) -> UntypedNode<'tree>

Upcast into an untyped node.

fn utf8_text<'a>(&self, source: &'a [u8]) -> Result<&'a str, Utf8Error>

See tree-sitter’s Node::utf8_text

fn utf16_text<'a>(&self, source: &'a [u16]) -> &'a [u16]

See tree-sitter’s Node::utf16_text

fn prefixes(&self) -> impl Iterator<Item = UntypedNode<'tree>>

Returns any extra nodes before this one, e.g., comments.

fn suffixes(&self) -> impl Iterator<Item = UntypedNode<'tree>>

Returns any extra nodes after this one, e.g., comments.

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

Get a cursor for this node

fn parent(&self) -> Option<UntypedNode<'tree>>

Get the node’s immediate parent

fn next_named_sibling(&self) -> Option<UntypedNode<'tree>>

Get the node’s immediate named next sibling

fn prev_named_sibling(&self) -> Option<UntypedNode<'tree>>

Get the node’s immediate named previous sibling

fn named_child_count(&self) -> usize

Get the number of named children

fn to_sexp(&self) -> String

Print the node as an s-expression

fn kind(&self) -> &'static str

Get this node’s tree-sitter name. See tree-sitter’s Node::kind

fn is_named(&self) -> bool

Check if this node is named. See tree-sitter’s Node::is_named

fn has_changes(&self) -> bool

Check if this node has been edited

fn has_error(&self) -> bool

Check if this node represents a syntax error or contains any syntax errors anywhere within it

fn start_byte(&self) -> usize

Get the byte offset where this node starts

fn end_byte(&self) -> usize

Get the byte offset where this node ends

fn start_position(&self) -> Point

Get the row and column where this node starts

fn end_position(&self) -> Point

Get the row and column where this node ends

fn range(&self) -> Range

Get the byte range and row and column range where this node is located

fn byte_range(&self) -> Range<usize>

Get the byte range where this node is located

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

Edit this node to keep it in-sync with source code that has been edited. See tree-sitter’s Node::edit