Struct Memory 

pub struct Memory { /* private fields */ }

Sparse, BCT-backed guest memory.

Implementations

impl Memory

pub fn new() -> Self

Empty memory. Every address reads as uninitialised.

pub fn pages_allocated(&self) -> usize

How many pages are currently allocated. For tests and diagnostics.

pub fn is_aligned(addr: Word) -> bool

True when addr is word-aligned. Equivalent to testing whether the low trit is zero. Applies at every width, since everything aligns to the word (D-14).

pub fn read_tryte(&self, addr: Word) -> Result<Tryte, MemoryError>

Reads one tryte. Errors if it was never written.

pub fn write_tryte( &mut self, addr: Word, value: Tryte, ) -> Result<(), MemoryError>

Writes one tryte, allocating its page if needed.

pub fn is_initialised(&self, addr: Word) -> bool

True when this address holds a value that was actually written.

pub fn read_word(&self, addr: Word) -> Result<Word, MemoryError>

Reads a word: three trytes, least significant first.

Requires word alignment. The tryte at addr holds trits 0..9, the next holds 9..18, and the last holds 18..27, so the weights are 3^0, 3^9 and 3^18.

pub fn write_word(&mut self, addr: Word, value: Word) -> Result<(), MemoryError>

Writes a word: three trytes, least significant first.

pub fn read_double(&self, addr: Word) -> Result<DoubleWord, MemoryError>

Reads a double word: six trytes, least significant first.

Aligned to the word rather than to its own six trytes. Six-tryte alignment would require testing addr mod 6 == 0, which in base 3 means checking that the low trit is zero and the digit sum is even, a 27-trit reduction rather than a single trit test (D-14).

pub fn write_double( &mut self, addr: Word, value: DoubleWord, ) -> Result<(), MemoryError>

Writes a double word: six trytes, least significant first.

Trait Implementations

impl Addressable for Memory

fn read_tryte(&mut self, addr: Word) -> Result<Tryte, MemoryError>

Reads one tryte.

fn write_tryte(&mut self, addr: Word, value: Tryte) -> Result<(), MemoryError>

Writes one tryte.

fn read_word(&mut self, addr: Word) -> Result<Word, MemoryError>

Reads a word: three trytes, least significant first.

fn write_word(&mut self, addr: Word, value: Word) -> Result<(), MemoryError>

Writes a word: three trytes, least significant first.

fn is_privileged(&self, _addr: Word) -> bool

True if reaching addr should require supervisor privilege.

fn interrupts(&self) -> Word

Which interrupt sources are asserting, one trit per source.

impl Default for Memory

fn default() -> Memory

Returns the “default value” for a type.