Struct SyntaxNode 

pub struct SyntaxNode { /* private fields */ }

A node in the untyped syntax tree.

Implementations

impl SyntaxNode

pub fn is<'a, T: AstNode<'a>>(&'a self) -> bool

Whether the node can be cast to the given AST node.

pub fn cast<'a, T: AstNode<'a>>(&'a self) -> Option<T>

Try to convert the node to a typed AST node.

impl SyntaxNode

pub fn leaf(kind: SyntaxKind, text: impl Into<EcoString>) -> Self

Create a new leaf node.

pub fn inner(kind: SyntaxKind, children: Vec<SyntaxNode>) -> Self

Create a new inner node with children.

pub fn error(message: impl Into<EcoString>, text: impl Into<EcoString>) -> Self

Create a new error node with a user-presentable message for the given text. Note that the message is the first argument, and the text causing the error is the second argument.

pub fn warn(&mut self, message: impl Into<EcoString>)

Add a warning message to an existing node.

pub fn warn_at(&mut self, _: Range<usize>, message: impl Into<EcoString>)

Add a warning around this node at a particular sub-range of the node’s text. Panics if the range is empty or exceeds the length of the wrapped text.

pub fn hint(&mut self, hint: impl Into<EcoString>)

Add a user-presentable hint to an existing error or warning. Panics if this is not an error or warning.

pub fn hint_at(&mut self, _: Range<usize>, hint: impl Into<EcoString>)

Add a user-presentable hint to an existing error or warning at a sub-range of the text. Panics if the range is empty or exceeds the length of the wrapped text. Panics if this is not an error or warning node.

pub fn with_hints(self, new_hints: impl IntoIterator<Item = EcoString>) -> Self

Add multiple hints while building an error or warning. Panics if this is not an error or warning.

pub const fn placeholder(kind: SyntaxKind) -> Self

Create a dummy node of the given kind.

Panics if kind is SyntaxKind::Error.

pub fn kind(&self) -> SyntaxKind

The type of the node.

pub fn is_empty(&self) -> bool

Return true if the length is 0.

pub fn len(&self) -> usize

The byte length of the node in the source text.

pub fn span(&self) -> Span

The span of the node.

pub fn leaf_text(&self) -> &EcoString

The text of the node if it is a leaf or error node.

Returns the empty string if this is an inner node.

pub fn full_text(&self) -> EcoString

Clone the full text from the node. If this is an inner node, it will traverse the tree to build the text which may be expensive.

pub fn children(&self) -> Iter<'_, SyntaxNode>

The node’s children.

pub fn diagnosis(&self) -> Diagnosis

Whether the node has diagnostic errors and/or warnings in it or its children. Diagnosis has public fields, so you can write node.diagnosis().errors to determine if a node is erroneous.

This can be used to determine whether Self::errors_and_warnings will return an empty vector without traversing the tree if it will not.

pub fn errors_and_warnings( &self, ) -> (Vec<SyntaxDiagnostic>, Vec<SyntaxDiagnostic>)

The error and warning diagnostics for this node and its descendants.

pub fn synthesize(&mut self, span: Span)

Set a synthetic span for the node and all its descendants.

pub fn synthesize_mapped( &mut self, id: FileId, mapper: &RangeMapper, ) -> Result<(), EcoString>

Set a raw range span for each node.

The range is determined by mapping the node’s ranges through the given mapper.

Returns an error with the mapper’s length if it was shorter than the length of the source text.

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

Whether the two syntax nodes are the same apart from spans.

Trait Implementations

impl Clone for SyntaxNode

fn clone(&self) -> SyntaxNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyntaxNode

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

Formats the value using the given formatter.

impl Default for SyntaxNode

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SyntaxNode

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SyntaxNode

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