Struct 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.

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.

Implementations

impl StackOutputs

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

Constructs a new StackOutputs struct from the provided stack elements.

Errors

Returns an error if the number of stack elements is greater than MIN_STACK_DEPTH (16).

pub fn try_from_ints<I>(iter: I) -> Result<StackOutputs, OutputError>

where I: IntoIterator<Item = u64>,

Attempts to create StackOutputs struct from the provided stack elements represented as vector of u64 values.

Errors

Returns an error if:

• Any of the provided stack elements 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_be(&self, idx: usize) -> Option<Word>

Returns the word located starting at the specified Felt position on the stack in big-endian (reversed) order, 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.

In big-endian order, stack element N+3 will be at position 0 of the word, N+2 at position 1, N+1 at position 2, and N at position 3. This matches the behavior of mem_loadw_be where mem[a+3] ends up on top of the stack.

pub fn get_stack_word_le(&self, idx: usize) -> Option<Word>

Returns the word located starting at the specified Felt position on the stack in little-endian (memory) order, 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.

In little-endian order, stack element N will be at position 0 of the word, N+1 at position 1, N+2 at position 2, and N+3 at position 3. This matches the behavior of mem_loadw_le where mem[a] ends up on top of the stack.

pub fn get_stack_word(&self, idx: usize) -> Option<Word>

👎Deprecated since 0.19.0: Use get_stack_word_be() or get_stack_word_le() to make endianness explicit

Returns the word located starting at the specified Felt position on the stack or None if out of bounds.

This is an alias for Self::get_stack_word_be for backward compatibility. For new code, prefer using the explicit get_stack_word_be() or get_stack_word_le() to make the ordering expectations clear.

See Self::get_stack_word_be for detailed documentation.

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_mut(&mut self) -> &mut [BaseElement]

Returns mutable access to the stack outputs, to be used for testing or running examples.

pub fn as_int_vec(&self) -> Vec<u64>

Converts the StackOutputs into the vector of u64 values.

Trait Implementations

impl Clone for StackOutputs

fn clone(&self) -> StackOutputs

Returns a duplicate 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 Deref for StackOutputs

type Target = [BaseElement; 16]

The resulting type after dereferencing.

fn deref(&self) -> &<StackOutputs as Deref>::Target

Dereferences the value.

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 From<[BaseElement; 16]> for StackOutputs

fn from(value: [BaseElement; 16]) -> StackOutputs

Converts to this type from the input type.

impl PartialEq for StackOutputs

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

impl StructuralPartialEq for StackOutputs