Struct UntypedNode 

pub struct UntypedNode<'tree>(/* private fields */);

A node that is untyped, but implements Node anyways.

It’s purpose is normalization: e.g. a method might take a Node parameter, so you can pass any kind of typed node, and you may want to just pass a regular node.

Implementations

impl<'tree> UntypedNode<'tree>

pub fn new(node: Node<'tree>) -> Self

Wrap the tree-sitter node so that it can be used wherever a Node can, but provides no type guarantees.

pub fn ref<'a>(node: &'a Node<'tree>) -> &'a Self

Convert a reference to a tree-sitter node into one of an untyped node.

This is a transmute, but safe since they have the same representation.

pub fn mut<'a>(node: &'a mut Node<'tree>) -> &'a mut Self

Convert a mutable reference to a tree-sitter node into one of an untyped node.

This is a transmute, but safe since they have the same representation.

pub fn is_error(&self) -> bool

Is this an error node?

pub fn is_missing(&self) -> bool

Is this a missing node?

pub fn is_extra(&self) -> bool

Is this an extra node?

pub fn downcast<Type: Node<'tree>>(&self) -> NodeResult<'_, Type>

Try to downcast to the given type.

See Node::try_from_raw.

Trait Implementations

impl<'tree> Clone for UntypedNode<'tree>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'tree> Debug for UntypedNode<'tree>

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

Formats the value using the given formatter.

impl<'tree> From<Node<'tree>> for UntypedNode<'tree>

fn from(value: Node<'tree>) -> Self

Converts to this type from the input type.

impl<'tree> Hash for UntypedNode<'tree>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'tree> Node<'tree> for UntypedNode<'tree>

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

Kind of nodes this wraps.

type WithLifetime<'a> = UntypedNode<'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

impl<'tree> PartialEq for UntypedNode<'tree>

fn eq(&self, other: &UntypedNode<'tree>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tree> Copy for UntypedNode<'tree>

impl<'tree> Eq for UntypedNode<'tree>

impl<'tree> StructuralPartialEq for UntypedNode<'tree>