Struct AdviceStack 

pub struct AdviceStack { /* private fields */ }

Advice stack values ordered from top to bottom.

The front of the stack is the next element consumed by adv_push.

Implementations

impl AdviceStack

pub fn new() -> Self

Creates a new empty advice stack.

pub fn try_from_values<I>(values: I) -> Result<Self, InputError>

where I: IntoIterator<Item = u64>,

Creates an advice stack from integer values ordered from top to bottom.

Errors

Returns an error if any value is not a valid field element.

pub fn len(&self) -> usize

Returns the number of elements on this advice stack.

pub fn is_empty(&self) -> bool

Returns true if this advice stack has no elements.

pub fn iter(&self) -> impl Iterator<Item = &Felt>

Returns an iterator over elements from top to bottom.

pub fn append_element(&mut self, value: Felt) -> &mut Self

Appends a single element to the bottom of the advice stack.

The appended element is consumed after all existing advice stack elements.

pub fn append_elements<I>(&mut self, values: I) -> &mut Self

where I: IntoIterator<Item = Felt>,

Appends raw elements to the bottom of the advice stack.

Values are ordered from top to bottom within the appended block.

pub fn prepend_elements<I>(&mut self, values: I) -> &mut Self

where I: IntoIterator<Item = Felt>,

Prepends raw elements ordered from top to bottom.

The first element in values becomes the next element consumed by advice operations.

pub fn push_element(&mut self, value: Felt) -> &mut Self

Pushes a single element onto the top of the advice stack.

pub fn prepend_word(&mut self, word: Word) -> &mut Self

Prepends a word to the top of the advice stack.

pub fn prepend_stack(&mut self, stack: AdviceStack) -> &mut Self

Prepends another advice stack to the top of this stack.

pub fn append_for_adv_push(&mut self, slice: &[Felt]) -> &mut Self

Appends elements for consumption by multiple sequential adv_push instructions.

After repeat.n adv_push end, the operand stack will have slice[0] on top.

pub fn append_word(&mut self, word: Word) -> &mut Self

Appends a word for consumption by adv_loadw or adv_pushw.

pub fn append_dword(&mut self, words: [Word; 2]) -> &mut Self

Appends two words for consumption by adv_pipe.

pub fn append_for_adv_pipe(&mut self, slice: &[Felt]) -> &mut Self

Appends elements for sequential consumption by adv_pipe operations.

Panics

Panics if the slice length is not a multiple of 8 (double-word aligned).

pub fn consume_element(&mut self) -> Option<Felt>

Consumes a single element from the top of the advice stack.

pub fn consume_word(&mut self) -> Option<Word>

Consumes a word from the top of the advice stack.

pub fn consume_dword(&mut self) -> Option<[Word; 2]>

Consumes two words from the top of the advice stack.

pub fn into_elements(self) -> Vec<Felt>

Consumes self and returns elements ordered from top to bottom.

Trait Implementations

impl Clone for AdviceStack

fn clone(&self) -> AdviceStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceStack

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

Formats the value using the given formatter.

impl Default for AdviceStack

fn default() -> AdviceStack

Returns the “default value” for a type.

impl Eq for AdviceStack

impl From<AdviceStack> for Vec<Felt>

fn from(stack: AdviceStack) -> Self

Converts to this type from the input type.

impl From<Vec<Felt>> for AdviceStack

fn from(stack: Vec<Felt>) -> Self

Converts to this type from the input type.

impl From<VecDeque<Felt>> for AdviceStack

fn from(stack: VecDeque<Felt>) -> Self

Converts to this type from the input type.

impl FromIterator<Felt> for AdviceStack

fn from_iter<T: IntoIterator<Item = Felt>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for AdviceStack

fn eq(&self, other: &AdviceStack) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AdviceStack