Enum umbra_lang::AST

pub enum AST {
    Macro {
        tokens: Vec<Token>,
    },
    Container {
        token: Token,
        children: Vec<AST>,
    },
    Operator {
        token: Token,
        lhs: Box<AST>,
        rhs: Box<AST>,
    },
    Value {
        token: Token,
    },
    Empty,
}

The parsed representation of a script expression.

Variants

Macro

A function call that accepts tokens as arguments.

Fields of Macro

tokens: Vec<Token>

Container

A collection of other expressions.

Fields of Container

token: Tokenchildren: Vec<AST>

Operator

An operation between two operands.

Fields of Operator

token: Tokenlhs: Box<AST>rhs: Box<AST>

Value

A singular value.

Fields of Value

token: Token

Empty

The empty AST, used to represent an empty child. Cannot be run.

Implementations

impl AST

pub fn to_string_lossy(&self) -> String

Returns a String representing the AST. Not guaranteed to be the same as the source script.

pub fn parse<I>(tokens: I, env: &Env<'_>) -> Result<AST, Error> where
    I: IntoIterator<Item = Token>, 

Parses the Token stream into a single AST representing the entire expression.

Errors

Will return Err if parse() on children resulted in an error. An internal function will error if it’s unable to reduce adjacent ASTs into a single AST.

pub fn run(&self, env: &Env<'_>) -> FnReturn

Runs the AST in the given environment and returns the value of the expression.

Trait Implementations

impl Clone for AST

fn clone(&self) -> AST

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AST

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

Formats the value using the given formatter.

impl Hash for AST

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 Ord for AST

fn cmp(&self, other: &AST) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<AST> for AST

fn eq(&self, other: &AST) -> bool

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

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

This method tests for !=.

impl PartialOrd<AST> for AST

fn partial_cmp(&self, other: &AST) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for AST

impl StructuralEq for AST

impl StructuralPartialEq for AST