Struct ExecutionOptions

pub struct ExecutionOptions { /* private fields */ }

Expand description

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 const MAX_CYCLES: u32

The maximum number of VM cycles a program is allowed to take.

pub const DEFAULT_CORE_TRACE_FRAGMENT_SIZE: usize = 4096

Default fragment size for core trace generation.

pub const DEFAULT_MAX_ADV_MAP_VALUE_SIZE: usize

Default maximum number of field elements in a single advice map value inserted via adv.insert_mem. Set to 2^17 (~1 MB given 8-byte field elements).

pub const DEFAULT_MAX_HASH_LEN_BYTES: usize

Default maximum number of input bytes for a single hash precompile invocation (e.g. keccak256, sha512, etc.). Set to 2^20 (1 MB).

pub const DEFAULT_MAX_NUM_CONTINUATIONS: usize

Default maximum number of continuations allowed on the continuation stack. Set to 2^16 (65536).

pub fn new( max_cycles: Option<u32>, expected_cycles: u32, core_trace_fragment_size: usize, enable_tracing: bool, enable_debugging: bool, ) -> Result<ExecutionOptions, 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 2^29.

§Errors

Returns an error if:

max_cycles is outside the valid range
after rounding up to the next power of two, expected_cycles exceeds max_cycles
core_trace_fragment_size is zero

pub fn with_core_trace_fragment_size( self, size: usize, ) -> Result<ExecutionOptions, ExecutionOptionsError>

Sets the fragment size for core trace generation.

Returns an error if the size is zero.

pub fn with_tracing(self, enable_tracing: bool) -> ExecutionOptions

Enables execution of the trace instructions.

pub fn with_debugging(self, enable_debugging: bool) -> ExecutionOptions

Enables execution of programs in debug mode when the enable_debugging flag is set to true; otherwise, debug mode is disabled.

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 core_trace_fragment_size(&self) -> usize

Returns the fragment size for core trace generation.

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.

pub fn max_adv_map_value_size(&self) -> usize

Returns the maximum number of field elements allowed in a single advice map value inserted via adv.insert_mem.

pub fn max_hash_len_bytes(&self) -> usize

Returns the maximum number of input bytes allowed for a single hash precompile invocation.

pub fn with_max_adv_map_value_size(self, size: usize) -> ExecutionOptions

Sets the maximum number of field elements allowed in a single advice map value inserted via adv.insert_mem.

pub fn with_max_hash_len_bytes(self, size: usize) -> ExecutionOptions

Sets the maximum number of input bytes allowed for a single hash precompile invocation.

pub fn max_num_continuations(&self) -> usize

Returns the maximum number of continuations allowed on the continuation stack.

pub fn with_max_num_continuations( self, max_num_continuations: usize, ) -> ExecutionOptions

Sets the maximum number of continuations allowed on the continuation stack.

Trait Implementations§

§

impl Clone for ExecutionOptions

§

fn clone(&self) -> ExecutionOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

§

impl Debug for ExecutionOptions

§

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

Formats the value using the given formatter. Read more

§

impl Default for ExecutionOptions

§

fn default() -> ExecutionOptions

Returns the “default value” for a type. Read more

§

impl PartialEq for ExecutionOptions

§

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

§

impl Eq for ExecutionOptions

§

impl StructuralPartialEq for ExecutionOptions

Auto Trait Implementations§

§

impl UnwindSafe for ExecutionOptions

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

§

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

§

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either [OwoColorize::fg] or a color-specific method, such as [OwoColorize::green], Read more

§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either [OwoColorize::bg] or a color-specific method, such as [OwoColorize::on_yellow], Read more

§