Enum cairo_vm::vm::runners::builtin_runner::BuiltinRunner

pub enum BuiltinRunner {
    Bitwise(BitwiseBuiltinRunner),
    EcOp(EcOpBuiltinRunner),
    Hash(HashBuiltinRunner),
    Output(OutputBuiltinRunner),
    RangeCheck(RangeCheckBuiltinRunner<RC_N_PARTS_STANDARD>),
    RangeCheck96(RangeCheckBuiltinRunner<RC_N_PARTS_96>),
    Keccak(KeccakBuiltinRunner),
    Signature(SignatureBuiltinRunner),
    Poseidon(PoseidonBuiltinRunner),
    SegmentArena(SegmentArenaBuiltinRunner),
    Mod(ModBuiltinRunner),
}

Variants

Bitwise(BitwiseBuiltinRunner)

EcOp(EcOpBuiltinRunner)

Hash(HashBuiltinRunner)

Output(OutputBuiltinRunner)

RangeCheck(RangeCheckBuiltinRunner<RC_N_PARTS_STANDARD>)

RangeCheck96(RangeCheckBuiltinRunner<RC_N_PARTS_96>)

Keccak(KeccakBuiltinRunner)

Signature(SignatureBuiltinRunner)

Poseidon(PoseidonBuiltinRunner)

SegmentArena(SegmentArenaBuiltinRunner)

Mod(ModBuiltinRunner)

Implementations

impl BuiltinRunner

pub fn initialize_segments(&mut self, segments: &mut MemorySegmentManager)

Creates the necessary segments for the builtin in the MemorySegmentManager and stores the first address on the builtin’s base

pub fn initial_stack(&self) -> Vec<MaybeRelocatable>

pub fn final_stack( &mut self, segments: &MemorySegmentManager, pointer: Relocatable, ) -> Result<Relocatable, RunnerError>

Returns the builtin’s final stack

pub fn get_allocated_memory_units( &self, vm: &VirtualMachine, ) -> Result<usize, MemoryError>

Returns the builtin’s allocated memory units

pub fn base(&self) -> usize

Returns the builtin’s base

pub fn ratio(&self) -> Option<u32>

pub fn add_validation_rule(&self, memory: &mut Memory)

pub fn deduce_memory_cell( &self, address: Relocatable, memory: &Memory, ) -> Result<Option<MaybeRelocatable>, RunnerError>

pub fn get_memory_segment_addresses(&self) -> (usize, Option<usize>)

pub fn get_used_cells( &self, segments: &MemorySegmentManager, ) -> Result<usize, MemoryError>

pub fn get_used_instances( &self, segments: &MemorySegmentManager, ) -> Result<usize, MemoryError>

pub fn get_range_check_usage(&self, memory: &Memory) -> Option<(usize, usize)>

pub fn get_used_perm_range_check_units( &self, vm: &VirtualMachine, ) -> Result<usize, MemoryError>

Returns the number of range check units used by the builtin.

pub fn get_used_diluted_check_units( &self, diluted_spacing: u32, diluted_n_bits: u32, ) -> usize

pub fn name(&self) -> BuiltinName

pub fn run_security_checks( &self, vm: &VirtualMachine, ) -> Result<(), VirtualMachineError>

pub fn get_used_cells_and_allocated_size( &self, vm: &VirtualMachine, ) -> Result<(usize, usize), MemoryError>

pub fn get_additional_data(&self) -> BuiltinAdditionalData

Returns data stored internally by builtins needed to re-execute from a cairo pie

pub fn extend_additional_data( &mut self, additional_data: &BuiltinAdditionalData, ) -> Result<(), RunnerError>

Extends the builtin’s internal data with the internal data obtained from a previous cairo execution Used solely when running from a cairo pie

pub fn air_private_input( &self, segments: &MemorySegmentManager, ) -> Vec<PrivateInput>

Trait Implementations

impl Clone for BuiltinRunner

fn clone(&self) -> BuiltinRunner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuiltinRunner

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

Formats the value using the given formatter.

impl From<BitwiseBuiltinRunner> for BuiltinRunner

fn from(runner: BitwiseBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<EcOpBuiltinRunner> for BuiltinRunner

fn from(runner: EcOpBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<HashBuiltinRunner> for BuiltinRunner

fn from(runner: HashBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<KeccakBuiltinRunner> for BuiltinRunner

fn from(runner: KeccakBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<ModBuiltinRunner> for BuiltinRunner

fn from(runner: ModBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<OutputBuiltinRunner> for BuiltinRunner

fn from(runner: OutputBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<PoseidonBuiltinRunner> for BuiltinRunner

fn from(runner: PoseidonBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<RangeCheckBuiltinRunner<RC_N_PARTS_96>> for BuiltinRunner

fn from(runner: RangeCheckBuiltinRunner<RC_N_PARTS_96>) -> Self

Converts to this type from the input type.

impl From<RangeCheckBuiltinRunner<RC_N_PARTS_STANDARD>> for BuiltinRunner

fn from(runner: RangeCheckBuiltinRunner<RC_N_PARTS_STANDARD>) -> Self

Converts to this type from the input type.

impl From<SegmentArenaBuiltinRunner> for BuiltinRunner

fn from(runner: SegmentArenaBuiltinRunner) -> Self

Converts to this type from the input type.

impl From<SignatureBuiltinRunner> for BuiltinRunner

fn from(runner: SignatureBuiltinRunner) -> Self

Converts to this type from the input type.