Struct rowan::SyntaxNode

pub struct SyntaxNode<T: Types> { /* fields omitted */ }

Akn 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<T: Types> SyntaxNode<T>

pub fn memory_size_of_red_children(&self) -> usize

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

impl<T: Types> SyntaxNode<T>

pub fn new(green: GreenNode<T>, data: T::RootData) -> TreeArc<T, SyntaxNode<T>>

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

pub fn green(&self) -> &GreenNode<T>

Get the green node for this node

pub fn replace_children(&self, children: Box<[GreenNode<T>]>) -> GreenNode<T>

Get the root node but with the children replaced. See replace_with.

pub fn replace_self(&self, green: GreenNode<T>) -> GreenNode<T>

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 TODO: naming is unfortunate, the return value is not current node, it is the new root node.

pub fn is_leaf(&self) -> bool

Returns true if this node is a leaf node.

pub fn leaf_text<'a>(&'a self) -> Option<&'a SmolStr>

Text of this node if it is a leaf.

pub fn root_data(&self) -> &T::RootData

Get root data.

pub fn kind(&self) -> T::Kind

Get kind of this node.

pub fn range(&self) -> TextRange

Get text range, covered by this node.

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

Get the parent node.

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

Get first child.

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

Get last child.

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

Get next sibling.

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

Get previous sibling.

Important traits for SyntaxNodeChildren<'a, T>

impl<'a, T: Types> Iterator for SyntaxNodeChildren<'a, T> type Item = &'a SyntaxNode<T>;

pub fn children(&self) -> SyntaxNodeChildren<T>

Get iterator over children.

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

All ancestors of the current node, including itself

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

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

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

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

Important traits for LeafAtOffset<T>

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

pub fn leaf_at_offset(&self, offset: TextUnit) -> LeafAtOffset<&SyntaxNode<T>>

Find a leaf 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) -> &SyntaxNode<T>

Return the deepest node 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<T: Types> TransparentNewType for SyntaxNode<T>

type Repr = SyntaxNode<T>

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<T: Types> PartialEq<SyntaxNode<T>> for SyntaxNode<T>

fn eq(&self, other: &SyntaxNode<T>) -> 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<T: Types> Eq for SyntaxNode<T>

impl<T> Send for SyntaxNode<T> where     T: Types,     T::RootData: Send,     T::Kind: Send,

impl<T: Types> ToOwned for SyntaxNode<T>

type Owned = TreeArc<T, SyntaxNode<T>>

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

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<T> Sync for SyntaxNode<T> where     T: Types,     T::RootData: Sync + Send,     T::Kind: Sync + Send,

impl<T: Types> Display for SyntaxNode<T>

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

Formats the value using the given formatter.

impl<T: Types> Debug for SyntaxNode<T>

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

Formats the value using the given formatter.

impl<T: Types> Hash for SyntaxNode<T>

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<T> UnwindSafe for SyntaxNode<T> where     T: Types,     T::RootData: UnwindSafe,     T::Kind: UnwindSafe,

impl<T> RefUnwindSafe for SyntaxNode<T> where     T: Types,     T::RootData: RefUnwindSafe + UnwindSafe,     T::Kind: RefUnwindSafe + UnwindSafe,