Struct StackOutputs 

pub struct StackOutputs { /* private fields */ }

Defines the final state of the VM’s operand stack at the end of program execution.

The first element is at position 0 (top of stack).

Implementations

impl StackOutputs

pub fn new(values: &[Felt]) -> Result<Self, 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 get_element(&self, idx: usize) -> Option<Felt>

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

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

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

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. Word[0] corresponds to the top of the stack.

pub fn get_num_elements(&self, num_outputs: usize) -> &[Felt]

Returns the number of requested elements up to the maximum available in the stack outputs.

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

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 = [Goldilocks; 16]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deserializable for StackOutputs

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

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

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

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

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

Deserializes Self from bytes with a byte budget limit.

impl From<[Goldilocks; 16]> for StackOutputs

fn from(value: [Felt; 16]) -> Self

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: ByteWriter>(&self, target: &mut W)

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 Copy for StackOutputs

impl Eq for StackOutputs

impl StructuralPartialEq for StackOutputs