Enum Node

pub enum Node<'a> {
    Program(&'a Node<Program>),
    ImportStatement(&'a Node<ImportStatement>),
    ExpressionStatement(&'a Node<ExpressionStatement>),
    VariableDeclaration(&'a Node<VariableDeclaration>),
    TypeDeclaration(&'a Node<TypeDeclaration>),
    ReturnStatement(&'a Node<ReturnStatement>),
    VariableDeclarator(&'a Node<VariableDeclarator>),
    Literal(&'a Node<Literal>),
    TagDeclarator(&'a Node<TagDeclarator>),
    Identifier(&'a Node<Identifier>),
    Name(&'a Node<Name>),
    BinaryExpression(&'a Node<BinaryExpression>),
    FunctionExpression(&'a Node<FunctionExpression>),
    CallExpressionKw(&'a Node<CallExpressionKw>),
    PipeExpression(&'a Node<PipeExpression>),
    PipeSubstitution(&'a Node<PipeSubstitution>),
    ArrayExpression(&'a Node<ArrayExpression>),
    ArrayRangeExpression(&'a Node<ArrayRangeExpression>),
    ObjectExpression(&'a Node<ObjectExpression>),
    MemberExpression(&'a Node<MemberExpression>),
    UnaryExpression(&'a Node<UnaryExpression>),
    IfExpression(&'a Node<IfExpression>),
    ElseIf(&'a ElseIf),
    LabelledExpression(&'a Node<LabelledExpression>),
    AscribedExpression(&'a Node<AscribedExpression>),
    Parameter(&'a Parameter),
    ObjectProperty(&'a Node<ObjectProperty>),
    KclNone(&'a KclNone),
}

The “Node” type wraps all the AST elements we’re able to find in a KCL file. Tokens we walk through will be one of these.

Variants

Program(&'a Node<Program>)

ImportStatement(&'a Node<ImportStatement>)

ExpressionStatement(&'a Node<ExpressionStatement>)

VariableDeclaration(&'a Node<VariableDeclaration>)

TypeDeclaration(&'a Node<TypeDeclaration>)

ReturnStatement(&'a Node<ReturnStatement>)

VariableDeclarator(&'a Node<VariableDeclarator>)

Literal(&'a Node<Literal>)

TagDeclarator(&'a Node<TagDeclarator>)

Identifier(&'a Node<Identifier>)

Name(&'a Node<Name>)

BinaryExpression(&'a Node<BinaryExpression>)

FunctionExpression(&'a Node<FunctionExpression>)

CallExpressionKw(&'a Node<CallExpressionKw>)

PipeExpression(&'a Node<PipeExpression>)

PipeSubstitution(&'a Node<PipeSubstitution>)

ArrayExpression(&'a Node<ArrayExpression>)

ArrayRangeExpression(&'a Node<ArrayRangeExpression>)

ObjectExpression(&'a Node<ObjectExpression>)

MemberExpression(&'a Node<MemberExpression>)

UnaryExpression(&'a Node<UnaryExpression>)

IfExpression(&'a Node<IfExpression>)

ElseIf(&'a ElseIf)

LabelledExpression(&'a Node<LabelledExpression>)

AscribedExpression(&'a Node<AscribedExpression>)

Parameter(&'a Parameter)

ObjectProperty(&'a Node<ObjectProperty>)

KclNone(&'a KclNone)

Implementations

impl Node<'_>

pub fn digest(&self) -> Option<[u8; 32]>

Return the digest of the Node, pulling the underlying Digest from the AST types.

The Digest type may change over time.

pub fn ptr_eq(&self, other: Node<'_>) -> bool

Check to see if this Node points to the same underlying specific borrowed object as another Node. This is not the same as Eq or even PartialEq – anything that is true here is absolutely Eq, but it’s possible this node is Eq to another with this being false.

This merely indicates that this Node specifically is the exact same borrowed object as Node.

Trait Implementations

impl<'a> Clone for Node<'a>

fn clone(&self) -> Node<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Node<'a>

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

Formats the value using the given formatter.

impl TryFrom<&Node<'_>> for SourceRange

type Error = AstNodeError

The type returned in the event of a conversion error.

fn try_from(node: &Node<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'tree> Visitable<'tree> for Node<'tree>

fn node(&self) -> Node<'tree>

Return self as a Node. Generally speaking, the Visitable trait is only going to be implemented on Node, so this is purely used by helpers that are generic over a Visitable and want to deref back into a Node.

fn children(&self) -> Vec<Node<'tree>>

Return a Vec<Node> for all direct children of this AST node. This should only contain direct descendants.

fn visit<VisitorT>(&self, visitor: VisitorT) -> Result<bool, VisitorT::Error>

where VisitorT: Visitor<'tree>,

Call the provided [Visitor] in order to Visit self. This will only be called on self – the [Visitor] is responsible for recursing into any children, if desired.

impl<'a> Copy for Node<'a>