Struct miden_air::ExecutionOptions

pub struct ExecutionOptions { /* private fields */ }

A set of parameters specifying execution parameters of the VM.

• max_cycles specifies the maximum number of cycles a program is allowed to execute.
• expected_cycles specifies the number of cycles a program is expected to execute.

Implementations

impl ExecutionOptions

pub fn new( max_cycles: Option<u32>, expected_cycles: u32, enable_tracing: bool ) -> Result<Self, ExecutionOptionsError>

Creates a new instance of ExecutionOptions from the specified parameters.

If the max_cycles is None the maximum number of cycles will be set to u32::MAX

pub fn with_tracing(self) -> Self

Enables execution of the trace instructions.

pub fn with_debugging(self) -> Self

Enables execution of programs in debug mode.

In debug mode the VM does the following:

• Executes debug instructions (these are ignored in regular mode).
• Records additional info about program execution (e.g., keeps track of stack state at every cycle of the VM) which enables stepping through the program forward and backward.

pub fn max_cycles(&self) -> u32

Returns maximum number of cycles a program is allowed to execute for.

pub fn expected_cycles(&self) -> u32

Returns the number of cycles a program is expected to take.

This will serve as a hint to the VM for how much memory to allocate for a program’s execution trace and may result in performance improvements when the number of expected cycles is equal to the number of actual cycles.

pub fn enable_tracing(&self) -> bool

Returns a flag indicating whether the VM should execute trace instructions.

pub fn enable_debugging(&self) -> bool

Returns a flag indicating whether the VM should execute a program in debug mode.

Trait Implementations

impl Clone for ExecutionOptions

fn clone(&self) -> ExecutionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutionOptions

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

Formats the value using the given formatter.

impl Default for ExecutionOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ExecutionOptions

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

impl Eq for ExecutionOptions

impl StructuralPartialEq for ExecutionOptions