Struct Memory 

pub struct Memory {
    pub addresses: Vec<Option<Primitive>>,
    pub stack: Stack<Vec<Primitive>>,
    pub sketch_groups: Vec<SketchGroup>,
}

KCEP’s program memory. A flat, linear list of values.

Fields

addresses: Vec<Option<Primitive>>

Each address of memory.

stack: Stack<Vec<Primitive>>

A stack where temporary values can be pushed or popped.

sketch_groups: Vec<SketchGroup>

Special storage for SketchGroups.

Implementations

impl Memory

pub fn set(&mut self, address: Address, value: Primitive)

Store a value in KCEP’s program memory.

pub fn set_composite<T: Value>( &mut self, start: Address, composite_value: T, ) -> usize

Store a value value (i.e. a value which takes up multiple addresses in memory). Store its parts in consecutive memory addresses starting at start. Returns how many memory addresses the data took up.

pub fn iter(&self) -> impl Iterator<Item = (usize, &Option<Primitive>)>

Iterate over each memory address and its value.

pub fn get_primitive<T>(&self, addr: &Address) -> Result<T, ExecutionError>

where T: TryFrom<Primitive, Error = MemoryError>,

Get a primitive from addr. If it’s of type T, extract that T. Otherwise error.

pub fn get_size(&self, addr: &Address) -> Result<usize, ExecutionError>

Look for either a usize or an object/list header at the given address. Return that usize, or the size field of the header.

pub fn get_slice( &self, start: Address, len: usize, ) -> Result<Vec<Primitive>, ExecutionError>

Get a range of addresses, starting at start and continuing for len more.

pub fn get_in_memory<T: Value>( &mut self, source: InMemory, field_name: &'static str, events: &mut EventWriter, ) -> Result<(T, usize), MemoryError>

Read a T value out of memory (either addressable or stack).

pub fn debug_table_stack(&self) -> String

Return a nicely-formatted table of stack.

pub fn debug_table(&self, up_to: Option<usize>) -> String

Return a nicely-formatted table of memory.

pub fn last_nonempty_address(&self) -> Option<usize>

Get the address of the last non-empty address. If none, then all addresses are empty.

pub fn next_empty_cell(&self) -> Option<usize>

Get the address of the last empty cell. If none, then all cells are occupied.

Trait Implementations

impl Clone for Memory

fn clone(&self) -> Memory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Memory

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

Formats the value using the given formatter.

impl Default for Memory

fn default() -> Self

Returns the “default value” for a type.

impl ReadMemory for Memory

fn get(&self, address: &Address) -> Option<&Primitive>

Get a value from KCEP’s program memory.

fn get_composite<T: Value>( &self, start: Address, ) -> Result<(T, usize), MemoryError>

Get a value value (i.e. a value which takes up multiple addresses in memory). Its parts are stored in consecutive memory addresses starting at start.

fn stack_pop(&mut self) -> Result<Vec<Primitive>, MemoryError>

Remove the value on top of the stack, return it.

fn stack_peek(&self) -> Result<Vec<Primitive>, MemoryError>

Return the value on top of the stack.

fn get_ok(&self, address: &Address) -> Result<Vec<Primitive>, MemoryError>

Same as get but match the return signature of stack operations.