Struct typst_syntax::SyntaxNode

pub struct SyntaxNode(/* private fields */);

A node in the untyped syntax tree.

Implementations

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.

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 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 into_text(self) -> EcoString

Extract the text from the node.

Builds the string if this is an inner node.

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

The node’s children.

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.

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

Cast the first child that can cast to the AST type T.

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

Cast the last child that can cast to the AST type T.

pub fn erroneous(&self) -> bool

Whether the node or its children contain an error.

pub fn errors(&self) -> Vec<SyntaxError>

The error messages for this node and its descendants.

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

Add a user-presentable hint if this is an error node.

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

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

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 copy 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 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

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

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

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

impl Eq for SyntaxNode

impl StructuralPartialEq for SyntaxNode