Struct miden_processor::StackOutputs

pub struct StackOutputs { /* private fields */ }

Output container for Miden VM programs.

Miden program outputs contain the full state of the stack at the end of execution as well as the addresses in the overflow table which are required to reconstruct the table (when combined with the overflow values from the stack state).

stack is expected to be ordered as if the elements were popped off the stack one by one. Thus, the value at the top of the stack is expected to be in the first position, and the order of the rest of the output elements will also match the order on the stack.

overflow_addrs is expected to start with the prev address value from the first row in the overflow table (the row representing the deepest element in the stack) and then be followed by the address (clk value) of each row in the table starting from the deepest element in the stack and finishing with the row which was added to the table last.

Implementations

impl StackOutputs

pub const MAX_LEN: usize = 65_535usize

pub fn new( stack: Vec<BaseElement>, overflow_addrs: Vec<BaseElement> ) -> Result<StackOutputs, OutputError>

Constructs a new StackOutputs struct from the provided stack elements and overflow addresses.

Errors

Returns an error if the number of stack elements is greater than STACK_TOP_SIZE (16) and overflow_addrs does not contain exactly stack.len() + 1 - STACK_TOP_SIZE elements.

pub fn try_from_ints( stack: Vec<u64>, overflow_addrs: Vec<u64> ) -> Result<StackOutputs, OutputError>

Attempts to create StackOutputs struct from the provided stack elements and overflow addresses represented as vectors of u64 values.

Errors

Returns an error if:

• Any of the provided stack elements are invalid field elements.
• Any of the provided overflow addresses are invalid field elements.

pub fn get_stack_item(&self, idx: usize) -> Option<BaseElement>

Returns the element located at the specified position on the stack or None if out of bounds.

pub fn get_stack_word(&self, idx: usize) -> Option<[BaseElement; 4]>

Returns the word located starting at the specified Felt position on the stack or None if out of bounds. For example, passing in 0 returns the word at the top of the stack, and passing in 4 returns the word starting at element index 4.

pub fn stack(&self) -> &[BaseElement]

Returns the stack outputs, which is state of the stack at the end of execution converted to integers.

pub fn stack_truncated(&self, num_outputs: usize) -> &[BaseElement]

Returns the number of requested stack outputs or returns the full stack if fewer than the requested number of stack values exist.

pub fn stack_top(&self) -> [BaseElement; 16]

Returns the state of the top of the stack at the end of execution.

pub fn overflow_addrs(&self) -> &[BaseElement]

Returns the overflow address outputs, which are the addresses required to reconstruct the overflow table (when combined with the stack overflow values) converted to integers.

pub fn has_overflow(&self) -> bool

Returns true if the overflow table outputs are non-empty.

pub fn overflow_prev(&self) -> BaseElement

Returns the previous address prev for the first row in the stack overflow table

pub fn stack_overflow(&self) -> Vec<(BaseElement, BaseElement)>

Returns (address, value) for all rows which were on the overflow table at the end of execution in the order in which they were added to the table (deepest stack item first).

pub fn stack_mut(&mut self) -> &mut [BaseElement]

Returns mutable access to the stack outputs, to be used for testing or running examples. TODO: this should be marked with #[cfg(test)] attribute, but that currently won’t work with the integration test handler util.

Trait Implementations

impl Clone for StackOutputs

fn clone(&self) -> StackOutputs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StackOutputs

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

Formats the value using the given formatter.

impl Default for StackOutputs

fn default() -> StackOutputs

Returns the “default value” for a type.

impl Deserializable for StackOutputs

fn read_from<R>(source: &mut R) -> Result<StackOutputs, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for StackOutputs

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl ToElements<BaseElement> for StackOutputs

fn to_elements(&self) -> Vec<BaseElement>

impl Eq for StackOutputs

impl StructuralPartialEq for StackOutputs