Struct Memory

pub struct Memory<'a> { /* private fields */ }

A memory on a virtual machine.

Implementations

impl<'a> Memory<'a>

pub fn new(heap: &'a mut [Value]) -> Result<Self, Error>

Creates a memory.

pub const fn code(&self) -> Cons

Returns a code.

pub const fn set_code(&mut self, value: Cons)

Sets a code.

pub const fn register(&self) -> Cons

Returns a register.

pub const fn set_register(&mut self, value: Cons)

Sets a register.

pub const fn stack(&self) -> Cons

Returns a stack.

pub const fn set_stack(&mut self, value: Cons)

Sets a stack.

pub const fn boolean(&self, value: bool) -> Cons

Returns a boolean value.

pub const fn null(&self) -> Cons

Returns a null value.

pub fn push(&mut self, value: Value) -> Result<(), Error>

Pushes a value to a stack.

pub fn pop(&mut self) -> Value

Pops a value from a stack.

pub fn pop_many<const M: usize>(&mut self) -> [Value; M]

Pops values from a stack.

pub fn pop_numbers<const M: usize>(&mut self) -> [Number; M]

Pops numbers from a stack.

pub fn top(&self) -> Value

Peeks a value at the top of a stack.

pub fn set_top(&mut self, value: Value)

Sets a value at the top of a stack.

pub fn cons(&mut self, car: Value, cdr: Cons) -> Result<Cons, Error>

Allocates a cons with a default tag of Type::Pair.

pub fn allocate(&mut self, car: Value, cdr: Value) -> Result<Cons, Error>

Allocates a cons.

pub const fn size(&self) -> usize

Returns a heap size.

pub const fn allocation_index(&self) -> usize

Returns the current allocation index relative an allocation start index.

pub const fn allocation_start(&self) -> usize

Returns an allocation start index.

pub const fn allocation_end(&self) -> usize

Returns an allocation end index.

pub const fn car(&self, cons: Cons) -> Value

Returns a value of a car field in a cons.

pub const fn cdr(&self, cons: Cons) -> Value

Returns a value of a cdr field in a cons.

pub const fn car_value(&self, cons: Value) -> Value

Returns a value of a car field in a value assumed as a cons.

pub const fn cdr_value(&self, cons: Value) -> Value

Returns a value of a cdr field in a value assumed as a cons.

pub fn set_raw_car(&mut self, cons: Cons, value: Value)

Sets a raw value to a car field in a cons overwriting its tag.

pub fn set_raw_cdr(&mut self, cons: Cons, value: Value)

Sets a raw value to a cdr field in a cons overwriting its tag.

pub fn set_car(&mut self, cons: Cons, value: Value)

Sets a value to a car field in a cons.

pub fn set_cdr(&mut self, cons: Cons, value: Value)

Sets a value to a cdr field in a cons.

pub fn set_car_value(&mut self, cons: Value, value: Value)

Sets a value to a car field in a value assumed as a cons.

pub fn set_cdr_value(&mut self, cons: Value, value: Value)

Sets a value to a cdr field in a value assumed as a cons.

pub const fn tail(&self, list: Cons, index: usize) -> Cons

Returns a tail of a list.

pub fn build_string(&mut self, string: &str) -> Result<Cons, Error>

Builds a string.

pub fn build_raw_string(&mut self, string: &str) -> Result<Cons, Error>

Builds a raw string.

pub fn operate_top( &mut self, operate: impl Fn(&Self, Value) -> Value, ) -> Result<(), Error>

Executes an operation against a value at the top of a stack.

pub fn list_length(&self, list: Cons) -> usize

Calculates a length of a list.

pub fn operate_unary( &mut self, operate: fn(Number) -> Number, ) -> Result<(), Error>

Executes an unary number operation.

pub fn operate_binary( &mut self, operate: fn(Number, Number) -> Number, ) -> Result<(), Error>

Executes a binary number operation.

pub fn collect_garbages(&mut self, cons: Option<&mut Cons>) -> Result<(), Error>

Collects garbage memory blocks.

Trait Implementations

impl Display for Memory<'_>

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

Formats the value using the given formatter.

impl Write for Memory<'_>

fn write_str(&mut self, string: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.