Enum ProcessState

pub enum ProcessState<'a> {
    Slow(SlowProcessState<'a>),
    Fast(FastProcessState<'a>),
}

Variants

Slow(SlowProcessState<'a>)

Fast(FastProcessState<'a>)

Implementations

impl<'a> ProcessState<'a>

pub fn advice_provider(&self) -> &AdviceProvider

Returns a reference to the advice provider.

pub fn advice_provider_mut(&mut self) -> &mut AdviceProvider

Returns a mutable reference to the advice provider.

pub fn clk(&self) -> RowIndex

Returns the current clock cycle of a process.

pub fn ctx(&self) -> ContextId

Returns the current execution context ID.

pub fn fmp(&self) -> u64

Returns the current value of the free memory pointer.

pub fn get_stack_item(&self, pos: usize) -> Felt

Returns the value located at the specified position on the stack at the current clock cycle.

pub fn get_stack_word(&self, word_idx: usize) -> Word

Returns a word located at the specified word index on the stack.

Specifically, word 0 is defined by the first 4 elements of the stack, word 1 is defined by the next 4 elements etc. Since the top of the stack contains 4 word, the highest valid word index is 3.

The words are created in reverse order. For example, for word 0 the top element of the stack will be at the last position in the word.

Creating a word does not change the state of the stack.

pub fn get_stack_state(&self) -> Vec<Felt>

Returns stack state at the current clock cycle. This includes the top 16 items of the stack + overflow entries.

pub fn get_mem_value(&self, ctx: ContextId, addr: u32) -> Option<Felt>

Returns the element located at the specified context/address, or None if the address hasn’t been accessed previously.

pub fn get_mem_word( &self, ctx: ContextId, addr: u32, ) -> Result<Option<Word>, MemoryError>

Returns the batch of elements starting at the specified context/address.

Errors

• If the address is not word aligned.

pub fn get_mem_state(&self, ctx: ContextId) -> Vec<(MemoryAddress, Felt)>

Returns the entire memory state for the specified execution context at the current clock cycle.

The state is returned as a vector of (address, value) tuples, and includes addresses which have been accessed at least once.

Trait Implementations

impl<'a> Debug for ProcessState<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a mut Process> for ProcessState<'a>

fn from(process: &'a mut Process) -> Self

Converts to this type from the input type.