Struct Heap 

pub struct Heap { /* private fields */ }

A persistent map of addresses to cell values.

Implementations

impl Heap

pub fn empty() -> Self

An empty heap with the address counter at zero.

pub fn len(&self) -> usize

The number of cells currently live in the heap.

pub fn is_empty(&self) -> bool

Whether the heap holds no cells.

pub fn contains(&self, address: Address) -> bool

Whether the heap has a cell at address.

pub fn addresses(&self) -> impl Iterator<Item = Address> + '_

All addresses currently live in the heap, in ascending order.

pub fn alloc(&self, value: Value) -> (Self, Address)

Allocate a fresh cell holding value, returning the resulting heap and the new cell’s address.

pub fn load(&self, address: Address) -> Option<&Value>

Read the value held at address, or None if the address is dangling.

pub fn store(&self, address: Address, value: Value) -> Option<Self>

Return a heap with the cell at address set to value, or None if the address is dangling. Address counter is preserved.

pub fn retain(&self, live: &BTreeSet<Address>) -> Self

Return a heap containing only cells whose addresses are in live. The next-address counter is preserved so the surviving addresses stay stable and no future address ever collides with a freed one.

Trait Implementations

impl Clone for Heap

fn clone(&self) -> Heap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Heap

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

Formats the value using the given formatter.

impl Default for Heap

fn default() -> Self

Returns the “default value” for a type.

impl Display for Heap

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

Formats the value using the given formatter.

impl PartialEq for Heap

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

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

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 Eq for Heap

impl StructuralPartialEq for Heap