Enum rhai::Expr

pub enum Expr {
    DynamicConstant(Box<Dynamic>, Position),
    BoolConstant(bool, Position),
    IntegerConstant(INT, Position),
    FloatConstant(FloatWrapper<FLOAT>, Position),
    CharConstant(char, Position),
    StringConstant(ImmutableString, Position),
    InterpolatedString(Box<StaticVec<Expr>>, Position),
    Array(Box<StaticVec<Expr>>, Position),
    Map(Box<(StaticVec<(Ident, Expr)>, BTreeMap<Identifier, Dynamic>)>, Position),
    Unit(Position),
    Variable(Option<NonZeroU8>, Position, Box<(Option<NonZeroUsize>, Option<(NamespaceRef, u64)>, Identifier)>),
    Property(Box<((Identifier, u64), (Identifier, u64), (ImmutableString, Position))>),
    Stack(usize, Position),
    Stmt(Box<StmtBlock>),
    FnCall(Box<FnCallExpr>, Position),
    Dot(Box<BinaryExpr>, bool, Position),
    Index(Box<BinaryExpr>, bool, Position),
    And(Box<BinaryExpr>, Position),
    Or(Box<BinaryExpr>, Position),
    Custom(Box<CustomExpr>, Position),
}

(internals) An expression sub-tree. Exported under the internals feature only.

Volatile Data Structure

This type is volatile and may change.

Variants

DynamicConstant(Box<Dynamic>, Position)

Dynamic constant. Used to hold either an Array or Map literal for quick cloning. All other primitive data types should use the appropriate variants for better speed.

Tuple Fields of DynamicConstant

0: Box<Dynamic>1: Position

BoolConstant(bool, Position)

Boolean constant.

Tuple Fields of BoolConstant

0: bool1: Position

IntegerConstant(INT, Position)

Integer constant.

Tuple Fields of IntegerConstant

0: INT1: Position

FloatConstant(FloatWrapper<FLOAT>, Position)

Floating-point constant.

Not available under no_float.

Tuple Fields of FloatConstant

0: FloatWrapper<FLOAT>1: Position

CharConstant(char, Position)

Character constant.

Tuple Fields of CharConstant

0: char1: Position

StringConstant(ImmutableString, Position)

String constant.

Tuple Fields of StringConstant

0: ImmutableString1: Position

InterpolatedString(Box<StaticVec<Expr>>, Position)

An interpolated string.

Tuple Fields of InterpolatedString

0: Box<StaticVec<Expr>>1: Position

Array(Box<StaticVec<Expr>>, Position)

[ expr, … ]

Tuple Fields of Array

0: Box<StaticVec<Expr>>1: Position

Map(Box<(StaticVec<(Ident, Expr)>, BTreeMap<Identifier, Dynamic>)>, Position)

#{ name:expr, … }

Tuple Fields of Map

0: Box<(StaticVec<(Ident, Expr)>, BTreeMap<Identifier, Dynamic>)>1: Position

Unit(Position)

()

Tuple Fields of Unit

0: Position

Variable(Option<NonZeroU8>, Position, Box<(Option<NonZeroUsize>, Option<(NamespaceRef, u64)>, Identifier)>)

Variable access - optional short index, position, (optional index, optional (hash, modules), variable name)

The short index is u8 which is used when the index is <= 255, which should be the vast majority of cases (unless there are more than 255 variables defined!). This is to avoid reading a pointer redirection during each variable access.

Tuple Fields of Variable

0: Option<NonZeroU8>1: Position2: Box<(Option<NonZeroUsize>, Option<(NamespaceRef, u64)>, Identifier)>

Property(Box<((Identifier, u64), (Identifier, u64), (ImmutableString, Position))>)

Property access - ((getter, hash), (setter, hash), prop)

Tuple Fields of Property

0: Box<((Identifier, u64), (Identifier, u64), (ImmutableString, Position))>

Stack(usize, Position)

Stack slot

Tuple Fields of Stack

0: usize1: Position

Stmt(Box<StmtBlock>)

{ statement … }

Tuple Fields of Stmt

0: Box<StmtBlock>

FnCall(Box<FnCallExpr>, Position)

func ( expr , … )

Tuple Fields of FnCall

0: Box<FnCallExpr>1: Position

Dot(Box<BinaryExpr>, bool, Position)

lhs . rhs - bool variable is a dummy

Tuple Fields of Dot

0: Box<BinaryExpr>1: bool2: Position

Index(Box<BinaryExpr>, bool, Position)

expr [ expr ] - boolean indicates whether the dotting/indexing chain stops

Tuple Fields of Index

0: Box<BinaryExpr>1: bool2: Position

And(Box<BinaryExpr>, Position)

lhs && rhs

Tuple Fields of And

0: Box<BinaryExpr>1: Position

Or(Box<BinaryExpr>, Position)

lhs || rhs

Tuple Fields of Or

0: Box<BinaryExpr>1: Position

Custom(Box<CustomExpr>, Position)

Custom syntax

Tuple Fields of Custom

0: Box<CustomExpr>1: Position

Implementations

impl Expr

pub fn get_literal_value(&self) -> Option<Dynamic>

Get the Dynamic value of a literal constant expression.

Returns None if the expression is not a literal constant.

pub fn from_dynamic(value: Dynamic, pos: Position) -> Self

Create an Expr from a Dynamic value.

pub const fn position(&self) -> Position

Get the position of the expression.

pub fn set_position(&mut self, new_pos: Position) -> &mut Self

Override the position of the expression.

pub fn is_pure(&self) -> bool

Is the expression pure?

A pure expression has no side effects.

pub const fn is_unit(&self) -> bool

Is the expression the unit () literal?

pub fn is_constant(&self) -> bool

Is the expression a constant?

pub const fn is_valid_postfix(&self, token: &Token) -> bool

Is a particular token allowed as a postfix operator to this expression?

pub fn walk<'a>(
    &'a self,
    path: &mut Vec<ASTNode<'a>>,
    on_node: &mut impl FnMut(&[ASTNode<'_>]) -> bool
) -> bool

Recursively walk this expression. Return false from the callback to terminate the walk.

Trait Implementations

impl Clone for Expr

fn clone(&self) -> Expr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Expr

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

Formats the value using the given formatter.

impl Default for Expr

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<&'a Expr> for ASTNode<'a>

fn from(expr: &'a Expr) -> Self

Performs the conversion.

impl<'a> From<&'a Expr> for Expression<'a>

fn from(expr: &'a Expr) -> Self

Performs the conversion.

impl Hash for Expr

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.