Struct rowan::syntax::Node

pub struct Node<Lang = Generic> { /* fields omitted */ }

Node (or token) in the syntax tree.

Methods

impl<Lang: Language> Node<Lang>

Constructors and transformations between Nodes and Tokens.

pub fn new_root(
    green: impl Into<NodeOrToken<Arc<GreenNode>, Arc<GreenToken>>>,
    lang: Lang
) -> Self

Create a new root syntax node.

pub fn generic(self) -> Node<Generic>

A generic version of this node without language-specific behavior.

pub fn with_lang<L>(self, lang: L) -> Node<L>

This node with language-specific behavior.

pub fn is_token(&self) -> bool

Is this node a token?

Note: it is possible for a node to be backed by a green token without being a token, if the green token represents an unparsed subtree. For more info, see Language::is_token.

pub fn as_token(&self) -> Option<&Token<Lang>>

Convert this node into a token.

Panics

Panics if the node is not backed by a green token.

For a non-panicking version, use Token::new_ref.

pub fn into_token(self) -> Token<Lang>

Convert this node into a token.

Panics

Panics if the node is not a token or is not backed by a green token.

For a non-panicking version, use Token::new.

impl<Lang: Language> Node<Lang>

Tree traversal iterators.

pub fn walk(self) -> impl Iterator<Item = WalkEvent<Node<Lang>>>

Walk this subtree, including this node.

pub fn preorder(self) -> impl Iterator<Item = Node<Lang>>

All nodes in this subtree in preorder, including this node.

pub fn postorder(self) -> impl Iterator<Item = Node<Lang>>

All nodes in this subtree in postorder, including this node.

Important traits for Children<Lang>

impl<Lang: Language> Iterator for Children<Lang> type Item = Node<Lang>;

pub fn children(self) -> Children<Lang>

Child nodes (or tokens) of this node.

pub fn subtrees(self) -> impl Iterator<Item = Node<Lang>>

Children non-token subtrees of this node.

pub fn siblings(self, direction: Direction) -> impl Iterator<Item = Node<Lang>>

Sibling trees (and tokens) starting at and including this node.

pub fn ancestors(self) -> impl Iterator<Item = Node<Lang>>

The parent chain from this node, starting with this node.

impl<Lang: Language> Node<Lang>

Accessors.

pub fn green(&self) -> NodeOrToken<ArcBorrow<GreenNode>, ArcBorrow<GreenToken>>

The green element backing this syntax node.

pub fn kind(&self) -> Kind

The kind of this node.

pub fn text(self) -> Text

The text of this node.

pub fn text_range(&self) -> StrRange

The range of text this node covers.

pub fn replace_with(
    &self,
    replacement: impl Into<NodeOrToken<Arc<GreenNode>, Arc<GreenToken>>>
) -> NodeOrToken<Arc<GreenNode>, Arc<GreenToken>>

Create a new green tree with this node replaced. The complexity is proportional to the depth of the tree.

pub fn parent(self) -> Option<Node<Lang>>

The parent of this node.

pub fn next_sibling(self) -> Option<Node<Lang>>

The next token or node of this node's parent.

pub fn next_subtree(self) -> Option<Node<Lang>>

The next non-token node of this node's parent.

pub fn prev_sibling(self) -> Option<Node<Lang>>

The previous token or node of this node's parent.

pub fn prev_subtree(self) -> Option<Node<Lang>>

The previous non-token node of this node's parent.

pub fn first_child(self) -> Option<Node<Lang>>

The first child node or token of this node.

pub fn first_subtree(self) -> Option<Node<Lang>>

The first child non-token subtree of this node.

pub fn last_child(self) -> Option<Node<Lang>>

The last child node or token of this node.

pub fn last_subtree(self) -> Option<Node<Lang>>

The last child non-token subtree of this node.

Trait Implementations

impl<Lang> Drop for Node<Lang>

fn drop(&mut self)

Executes the destructor for this type.

impl<Lang: Clone> Clone for Node<Lang>

fn clone(&self) -> Node<Lang>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Lang: Language> Eq for Node<Lang>

impl<Lang: Language> PartialEq<Node<Lang>> for Node<Lang>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<Lang: Debug> Debug for Node<Lang>

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

Formats the value using the given formatter.

impl<Lang: Language> Hash for Node<Lang>

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, 

Feeds a slice of this type into the given [Hasher].