Enum Stack

pub enum Stack {
    Push(Word),
    Pop,
    Dup,
    DupFrom,
    Swap,
    SwapIndex,
    Select,
    SelectRange,
    Repeat,
    RepeatEnd,
    Reserve,
    Load,
    Store,
}

Operations related to stack manipulation.

Variants

Push(Word)

0x01

Push one word onto the stack.

Bytecode Argument

This operation expects a 8-byte (1-word) argument following its opcode within bytecode.

Stack Output

[value]

Pop

0x02

Pop one word from the stack.

Stack Input

[a]

Dup

0x03

Duplicate the top word on the stack.

Stack Input

[value]

Stack Output

[value, value]

DupFrom

0x04: DUPF

Duplicate the word at the given stack depth index.

0 is the index of the element at the top of the stack.

Stack Input

[index]

Stack Output

[value_i]

Swap

0x05

Swap top two words on stack.

Stack Input

[a, b]

Stack Output

[b, a]

SwapIndex

0x06: SWAPI

Swap the top word on the stack with the word at the given stack depth index.

0 is the index of the element at the top of the stack.

Stack Input

[a, b, c, d, index]

Stack Output

[a, d, c, b]

Panics

• Index is out of range.

Select

0x07: SEL

Conditionally keep one of the top two elements on the stack.

If condition is true, the top element is kept.

Stack Input

[a, b, cond]

Stack Output

[b]

SelectRange

0x08: SLTR

Conditionally keep one of the top two ranges on the stack.

If condition is true, the top range is kept.

The ranges must be of equal length. The ranges must be stacked sequentially. Here N is len -1.

Stack Input

[arr_a_0, ..arr_a_N, arr_b_0, ..arr_b_N, len, cond]

Stack Output

[arr_b_0, ..arr_b_N]

Repeat

0x09: REP

Repeat a section of code the number of times. Takes a boolean to either count from 0 up or from the number of repeats down to 0.

Stack Input

[num_repeats, count_up_bool]

RepeatEnd

0x0A: REPE

Increment or decrements the top counter on the repeat stack. If the counter is counting up and counter == limit - 1 then this pops the counter and continues with the program. If the counter is counting down and the counter is 0 then this pops the counter and continues with the program. If it is < limit - 1 or > 0 respectively then the program jumps to the last Repeat

Panics

• If there is no counter on the repeat stack.
• If there is no repeat registered to return to.

Reserve

0x0B: RES

Reserve space on the stack for len words. The reserved space is set to 0.

Stack Input

[len]

Load

0x0C: LODS

Load the value at the given stack depth index relative to the bottom.

0 is the index of the element at the bottom of the stack.

Stack Input

[index]

Stack Output

[value]

Panics

• Index is out of range.

Store

0x0D: STOS

Store the value at the given stack depth index relative to the bottom.

0 is the index of the element at the bottom of the stack.

Stack Input

[index, value]

Panics

• Index is out of range.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Stack

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

Formats the value using the given formatter.

impl From<Stack> for Constraint

fn from(subgroup: Stack) -> Self

Converts to this type from the input type.

impl Hash for Stack

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

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Stack

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToBytes for Stack

type Bytes = Stack

The iterator yielding bytes.

fn to_bytes(&self) -> Self::Bytes

Convert the operation to its serialized form in bytes.

impl ToOpcode for Stack

type Opcode = Stack

The associated Opcode type.

fn to_opcode(&self) -> Self::Opcode

The opcode associated with this operation.

impl TryFromBytes for Stack

type Error = FromBytesError

Represents any error that might occur while parsing an op from bytes.

fn try_from_bytes( bytes: &mut impl Iterator<Item = u8>, ) -> Option<Result<Self, Self::Error>>

Parse a single operation from the given iterator yielding bytes.

impl Copy for Stack

impl Eq for Stack

impl StructuralPartialEq for Stack