Struct Memory

pub struct Memory {
    pub validated_addresses: AddressSet,
    /* private fields */
}

Fields

validated_addresses: AddressSet

Implementations

impl Memory

pub fn new() -> Memory

pub fn insert<V>(&mut self, key: Relocatable, val: V) -> Result<(), MemoryError>

where MaybeRelocatable: From<V>,

Inserts a value into a memory address Will return an Error if the segment index given by the address corresponds to a non-allocated segment, or if the inserted value is inconsistent with the current value at the memory cell If the address isnt contiguous with previously inserted data, memory gaps will be represented by None values

pub fn relocate_memory(&mut self) -> Result<(), MemoryError>

Relocates the memory according to the relocation rules and clears self.relocaction_rules.

pub fn get_integer( &self, key: Relocatable, ) -> Result<Cow<'_, Felt252>, MemoryError>

Gets the value from memory address as a Felt252 value. Returns an Error if the value at the memory address is missing or not a Felt252.

pub fn get_usize(&self, key: Relocatable) -> Result<usize, MemoryError>

Gets the value from memory address as a usize. Returns an Error if the value at the memory address is missing not a Felt252, or can’t be converted to usize.

pub fn get_relocatable( &self, key: Relocatable, ) -> Result<Relocatable, MemoryError>

Gets the value from memory address as a Relocatable value. Returns an Error if the value at the memory address is missing or not a Relocatable.

pub fn insert_value<T: Into<MaybeRelocatable>>( &mut self, key: Relocatable, val: T, ) -> Result<(), MemoryError>

Inserts a value into memory Returns an error if the memory cell asignment is invalid

pub fn add_validation_rule( &mut self, segment_index: usize, rule: ValidationRule, )

pub fn validate_existing_memory(&mut self) -> Result<(), MemoryError>

Applies validation_rules to the current memory

pub fn get_range( &self, addr: Relocatable, size: usize, ) -> Vec<Option<Cow<'_, MaybeRelocatable>>>

Gets a range of memory values from addr to addr + size The outputed range may contain gaps if the original memory has them

pub fn get_continuous_range( &self, addr: Relocatable, size: usize, ) -> Result<Vec<MaybeRelocatable>, MemoryError>

Gets a range of memory values from addr to addr + size Fails if there if any of the values inside the range is missing (memory gap)

pub fn get_integer_range( &self, addr: Relocatable, size: usize, ) -> Result<Vec<Cow<'_, Felt252>>, MemoryError>

Gets a range of Felt252 memory values from addr to addr + size Fails if there if any of the values inside the range is missing (memory gap), or is not a Felt252

pub fn mark_as_accessed(&mut self, addr: Relocatable)

pub fn get_amount_of_accessed_addresses_for_segment( &self, segment_index: usize, ) -> Option<usize>

Trait Implementations

impl Default for Memory

fn default() -> Self

Returns the “default value” for a type.

impl Display for Memory

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

Formats the value using the given formatter.

impl From<&Memory> for CairoPieMemory

fn from(mem: &Memory) -> CairoPieMemory

Converts to this type from the input type.