Struct rowan::SyntaxNode

pub struct SyntaxNode { /* fields omitted */ }

An immutable lazy constructed syntax tree with offsets and parent pointers.

The design is close to https://github.com/apple/swift/tree/bc3189a2d265bf7728ea0cfeb55f032bfe5beaf1/lib/Syntax

All nodes constituting a tree share the ownership by a tree. Internally, and Arc is used, but outside world observes nodes as &SyntaxNode or TreeArc<SyntaxNode>, where a TreeArc is an Arc-like smart pointer.

Methods

impl SyntaxNode

pub fn new(
    green: GreenNode,
    data: Option<Box<dyn Any + Send + Sync>>
) -> TreeArc<SyntaxNode>

Creates a new SyntaxNode, which becomes the root of the tree.

pub fn root_data(&self) -> Option<&(dyn Any + Send + Sync)>

Get root data.

pub fn green(&self) -> &GreenNode

Get the green node for this node

pub fn kind(&self) -> SyntaxKind

Get kind of this node.

pub fn range(&self) -> TextRange

Get text range, covered by this node.

pub fn parent(&self) -> Option<&SyntaxNode>

Get the parent node.

pub fn first_child(&self) -> Option<&SyntaxNode>

Get first child, excluding tokens.

pub fn first_child_or_token(&self) -> Option<SyntaxElement>

Get the first, including tokens.

pub fn last_child(&self) -> Option<&SyntaxNode>

Get last child, excluding tokens.

pub fn last_child_or_token(&self) -> Option<SyntaxElement>

Get last child, including tokens.

pub fn next_sibling(&self) -> Option<&SyntaxNode>

Get next sibling, excluding tokens.

pub fn next_sibling_or_token(&self) -> Option<SyntaxElement>

Get next sibling, including tokens.

pub fn prev_sibling(&self) -> Option<&SyntaxNode>

Get previous sibling, excluding tokens.

pub fn prev_sibling_or_token(&self) -> Option<SyntaxElement>

Get previous sibling, including tokens.

pub fn first_token(&self) -> Option<SyntaxToken>

Return the leftmost token in the subtree of this node

pub fn last_token(&self) -> Option<SyntaxToken>

Return the rightmost token in the subtree of this node

pub fn replace_with(&self, replacement: GreenNode) -> GreenNode

Returns a green tree, equal to the green tree this node belongs two, except with this node substitute. The complexity of operation is proportional to the depth of the tree

impl SyntaxNode

Important traits for SyntaxNodeChildren<'a>

impl<'a> Iterator for SyntaxNodeChildren<'a> type Item = &'a SyntaxNode;

pub fn children(&self) -> SyntaxNodeChildren

Get iterator over children, excluding tokens.

Important traits for SyntaxElementChildren<'a>

impl<'a> Iterator for SyntaxElementChildren<'a> type Item = SyntaxElement<'a>;

pub fn children_with_tokens(&self) -> SyntaxElementChildren

Get iterator over children, including tokens.

pub fn ancestors(&self) -> impl Iterator<Item = &SyntaxNode>

All ancestors of the current node, including itself

pub fn preorder(&self) -> impl Iterator<Item = WalkEvent<&SyntaxNode>>

Traverse the subtree rooted at the current node (including the current node) in preorder, excluding tokens.

pub fn preorder_with_tokens<'a>(
    &'a self
) -> impl Iterator<Item = WalkEvent<SyntaxElement<'a>>>

Traverse the subtree rooted at the current node (including the current node) in preorder, including tokens.

pub fn common_ancestor<'a>(&'a self, other: &'a SyntaxNode) -> &'a SyntaxNode

Returns common ancestor of the two nodes. Precondition: nodes must be from the same tree.

Important traits for TokenAtOffset<T>

impl<T> Iterator for TokenAtOffset<T> type Item = T;

pub fn token_at_offset<'a>(
    &'a self,
    offset: TextUnit
) -> TokenAtOffset<SyntaxToken<'a>>

Find a token in the subtree corresponding to this node, which covers the offset. Precondition: offset must be withing node's range.

pub fn covering_node(&self, range: TextRange) -> SyntaxElement

Return the deepest node or token in the current subtree that fully contains the range. If the range is empty and is contained in two leaf nodes, either one can be returned. Precondition: range must be contained withing the current node

pub fn memory_size_of_subtree(&self) -> usize

Number of memory bytes of occupied by subtree rooted at self.

Trait Implementations

impl TransparentNewType for SyntaxNode

type Repr = SyntaxNode

Underlying representation of a newtype.

fn from_repr(repr: &Self::Repr) -> &Self

Cast the underlying repr into a wrapper.

fn into_repr(&self) -> &Self::Repr

Cast wrapper to the underlying repr.

impl ToOwned for SyntaxNode

type Owned = TreeArc<SyntaxNode>

The resulting type after obtaining ownership.

fn to_owned(&self) -> TreeArc<SyntaxNode>

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning.

impl Sync for SyntaxNode

impl Eq for SyntaxNode

impl Send for SyntaxNode

impl PartialEq<SyntaxNode> for SyntaxNode

fn eq(&self, other: &SyntaxNode) -> 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<'a> From<&'a SyntaxNode> for SyntaxElement<'a>

fn from(node: &'a SyntaxNode) -> SyntaxElement<'a>

Performs the conversion.

impl Debug for SyntaxNode

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

Formats the value using the given formatter.

impl Display for SyntaxNode

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

Formats the value using the given formatter.

impl Hash for SyntaxNode

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].

impl UnwindSafe for SyntaxNode

impl RefUnwindSafe for SyntaxNode