Enum miden_processor::AdviceSource

pub enum AdviceSource {
    Value(Felt),
    Word(Word),
    Map {
        key: Word,
        include_len: bool,
    },
}

Specifies the source of the value(s) to be pushed onto the advice stack.

Variants

Value(Felt)

Puts a single value onto the advice stack.

Word(Word)

Puts a word (4 elements) onto the stack.

Map

Fetches a list of elements under the specified key from the advice map and pushes them onto the advice stack.

If include_len is set to true, this also pushes the number of elements onto the advice stack.

Note: this operation doesn’t consume the map element so it can be called multiple times for the same key.

Example

Given an advice stack [a, b, c, ...], and a map x |-> [d, e, f]:

A call push_stack(AdviceSource::Map { key: x, include_len: false }) will result in advice stack: [d, e, f, a, b, c, ...].

A call push_stack(AdviceSource::Map { key: x, include_len: true }) will result in advice stack: [3, d, e, f, a, b, c, ...].

Errors

Returns an error if the key was not found in the key-value map.

Fields

key: Word

include_len: bool

Trait Implementations

impl Clone for AdviceSource

fn clone(&self) -> AdviceSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceSource

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

Formats the value using the given formatter.

impl PartialEq for AdviceSource

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

impl Eq for AdviceSource

impl StructuralPartialEq for AdviceSource