Enum tyche::expr::Evaled

#[non_exhaustive]
pub enum Evaled<'a> {
    Num(i32),
    Dice(Rolled<'a>),
    Neg(Box<Self>),
    Add(Box<Self>, Box<Self>),
    Sub(Box<Self>, Box<Self>),
    Mul(Box<Self>, Box<Self>),
    DivDown(Box<Self>, Box<Self>),
    DivUp(Box<Self>, Box<Self>),
}

Tree structure of individual elements of an evaluated mathematical dice expression

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Num(i32)

Standalone integer

Dice(Rolled<'a>)

Rolled dice

Neg(Box<Self>)

Negation of an expression (makes the result of it negative)

Add(Box<Self>, Box<Self>)

Sum of two expressions

Sub(Box<Self>, Box<Self>)

Difference of two expressions

Mul(Box<Self>, Box<Self>)

Product of two expressions

DivDown(Box<Self>, Box<Self>)

Integer quotient of two expressions (rounded down)

DivUp(Box<Self>, Box<Self>)

Integer quotient of two expressions (rounded up)

Implementations

impl Evaled<'_>

pub fn calc(&self) -> Result<i32, CalcError>

Calculates the final result of the evaluated expression and all of its children (if any).

Errors

If there is an integer overflow or division error, or an error calculating the total of a set of dice rolls,an error variant will be returned.

pub fn into_owned(self) -> Evaled<'static>

Moves all of self’s owned data into a new instance and clones any unowned data in order to create a 'static instance of self.

Trait Implementations

impl<'a> Clone for Evaled<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Evaled<'a>

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

Formats the value using the given formatter.

impl Describe for Evaled<'_>

fn describe(&self, list_limit: Option<usize>) -> String

Builds a detailed expression string with additional information about non-deterministic elements. Any elements of the expression that can have a different result between multiple evaluations or multiple results should list all of the specific individual results that occurred (ideally, up to list_limit of them).

impl Display for Evaled<'_>

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

Formats the value using the given formatter.

The output of this implementation is equivalent to Self::describe(None).

impl HasOpType for Evaled<'_>

fn op_type(&self) -> OpType

Gets the type of this expression.

fn is_value(&self) -> bool

Checks whether this expression is a single value.

fn is_unary(&self) -> bool

Checks whether this expression is a unary operation.

fn is_additive(&self) -> bool

Checks whether this expression is an additive operation.

fn is_multiplicative(&self) -> bool

Checks whether this expression is a multiplicative operation.

fn is_binary(&self) -> bool

Checks whether this expression is a binary (additive or multiplicative) operation.

impl<'a> PartialEq for Evaled<'a>

fn eq(&self, other: &Evaled<'a>) -> 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<'a> Eq for Evaled<'a>

impl<'a> StructuralPartialEq for Evaled<'a>