Enum Instruction

pub enum Instruction {
    RollRange(RollRange),
    RollStandardDice(RollStandardDice),
    RollCustomDice(RollCustomDice),
    DropLowest(DropLowest),
    DropHighest(DropHighest),
    SumRollingRecord(SumRollingRecord),
    Add(Add),
    Sub(Sub),
    Mul(Mul),
    Div(Div),
    Mod(Mod),
    Exp(Exp),
    Neg(Neg),
    Return(Return),
}

An instruction in the intermediate representation of the dice language.

Variants

RollRange(RollRange)

RollStandardDice(RollStandardDice)

RollCustomDice(RollCustomDice)

DropLowest(DropLowest)

DropHighest(DropHighest)

SumRollingRecord(SumRollingRecord)

Add(Add)

Sub(Sub)

Mul(Mul)

Div(Div)

Mod(Mod)

Exp(Exp)

Neg(Neg)

Return(Return)

Implementations

impl Instruction

pub fn destination(&self) -> Option<AddressingMode>

Get the destination for the instruction, if any.

Returns

The destination, or None if the instruction has no destination.

pub fn sources(&self) -> Vec<AddressingMode>

Get the sources for the instruction, if any.

Returns

The sources, or an empty vector if the instruction has no sources.

pub const fn roll_range( dest: RollingRecordIndex, start: AddressingMode, end: AddressingMode, ) -> Self

Create an instruction to roll a range of dice.

Parameters

• dest: The destination rolling record.
• start: The start of the range.
• end: The end of the range.

Returns

The instruction.

pub const fn roll_standard_dice( dest: RollingRecordIndex, count: AddressingMode, faces: AddressingMode, ) -> Self

Create an instruction to roll standard dice.

Parameters

• dest: The destination rolling record.
• count: The number of dice to roll.
• faces: The number of faces on each die.

Returns

The instruction.

pub const fn roll_custom_dice( dest: RollingRecordIndex, count: AddressingMode, faces: Vec<i32>, ) -> Self

Create an instruction to roll custom dice.

Parameters

• dest: The destination rolling record.
• count: The number of dice to roll.
• faces: The number of faces on each die.

Returns

The instruction.

pub const fn drop_lowest( dest: RollingRecordIndex, count: AddressingMode, ) -> Self

Create an instruction to drop the lowest value from a rolling record.

Parameters

• dest: The destination rolling record.
• count: The number of dice to drop.

Returns

The instruction.

pub const fn drop_highest( dest: RollingRecordIndex, count: AddressingMode, ) -> Self

Create an instruction to drop the highest value from a rolling record.

Parameters

• dest: The destination rolling record.
• count: The number of dice to drop.

Returns

The instruction.

pub const fn sum_rolling_record( dest: RegisterIndex, src: RollingRecordIndex, ) -> Self

Create an instruction to sum the values in a rolling record.

Parameters

• dest: The destination register.
• src: The rolling record to sum.

Returns

The instruction.

pub const fn add( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to add two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn sub( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to subtract two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn mul( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to multiply two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn div( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to divide two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn mod( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to compute the remainder of two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn exp( dest: RegisterIndex, op1: AddressingMode, op2: AddressingMode, ) -> Self

Create an instruction to compute the exponentiation of two values.

Parameters

• dest: The destination register.
• op1: The first operand.
• op2: The second operand.

Returns

The instruction.

pub const fn neg(dest: RegisterIndex, op: AddressingMode) -> Self

Create an instruction to negate a value.

Parameters

• dest: The destination register.
• op: The source operand.

Returns

The instruction.

pub const fn return(src: AddressingMode) -> Self

Create an instruction to return a value from the function.

Parameters

• src: The return value.

Returns

The instruction.

Trait Implementations

impl<V, E> CanVisitInstructions<V, E> for Instruction

where V: InstructionVisitor<E>,

fn visit(&self, visitor: &mut V) -> Result<(), E>

Apply the specified visitor to the receiver.

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Instruction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Instruction

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

Formats the value using the given formatter.

impl From<Add> for Instruction

fn from(inst: Add) -> Self

Converts to this type from the input type.

impl From<Div> for Instruction

fn from(inst: Div) -> Self

Converts to this type from the input type.

impl From<DropHighest> for Instruction

fn from(inst: DropHighest) -> Self

Converts to this type from the input type.

impl From<DropLowest> for Instruction

fn from(inst: DropLowest) -> Self

Converts to this type from the input type.

impl From<Exp> for Instruction

fn from(inst: Exp) -> Self

Converts to this type from the input type.

impl From<Mod> for Instruction

fn from(inst: Mod) -> Self

Converts to this type from the input type.

impl From<Mul> for Instruction

fn from(inst: Mul) -> Self

Converts to this type from the input type.

impl From<Neg> for Instruction

fn from(inst: Neg) -> Self

Converts to this type from the input type.

impl From<Return> for Instruction

fn from(inst: Return) -> Self

Converts to this type from the input type.

impl From<RollCustomDice> for Instruction

fn from(inst: RollCustomDice) -> Self

Converts to this type from the input type.

impl From<RollRange> for Instruction

fn from(inst: RollRange) -> Self

Converts to this type from the input type.

impl From<RollStandardDice> for Instruction

fn from(inst: RollStandardDice) -> Self

Converts to this type from the input type.

impl From<Sub> for Instruction

fn from(inst: Sub) -> Self

Converts to this type from the input type.

impl From<SumRollingRecord> for Instruction

fn from(inst: SumRollingRecord) -> Self

Converts to this type from the input type.

impl Hash for Instruction

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Instruction

fn eq(&self, other: &Instruction) -> 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 Serialize for Instruction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Instruction> for Add

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Div

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for DropHighest

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for DropLowest

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Exp

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Mod

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Mul

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Neg

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Return

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for RollCustomDice

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for RollRange

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for RollStandardDice

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for Sub

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Instruction> for SumRollingRecord

type Error = ()

The type returned in the event of a conversion error.

fn try_from(inst: Instruction) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Instruction

impl StructuralPartialEq for Instruction