Enum ConstantExpr

pub enum ConstantExpr {
    Literal(Span<Felt>),
    Var(Ident),
    BinaryOp {
        span: SourceSpan,
        op: ConstantOp,
        lhs: Box<ConstantExpr>,
        rhs: Box<ConstantExpr>,
    },
    String(Ident),
    Word(Span<WordValue>),
}

Represents a constant expression or value in Miden Assembly syntax.

Variants

Literal(Span<Felt>)

A literal integer value.

Var(Ident)

A reference to another constant.

BinaryOp

An binary arithmetic operator.

Fields

span: SourceSpan

op: ConstantOp

lhs: Box<ConstantExpr>

rhs: Box<ConstantExpr>

String(Ident)

Word(Span<WordValue>)

Implementations

impl ConstantExpr

pub fn expect_literal(&self) -> Felt

Unwrap a literal value from this expression or panic.

This is used in places where we expect the expression to have been folded to a value, otherwise a bug occurred.

pub fn expect_string(&self) -> Arc<str>

pub fn try_fold(self) -> Result<Self, ParsingError>

Attempt to fold to a single value.

This will only succeed if the expression has no references to other constants.

Errors

Returns an error if an invalid expression is found while folding, such as division by zero.

Trait Implementations

impl Clone for ConstantExpr

fn clone(&self) -> ConstantExpr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConstantExpr

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

Formats the value using the given formatter.

impl PartialEq for ConstantExpr

fn eq(&self, other: &Self) -> 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 PrettyPrint for ConstantExpr

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Spanned for ConstantExpr

fn span(&self) -> SourceSpan

impl Eq for ConstantExpr