baryuxn 0.3.0

An implementation of the Uxn stack machine as a no_std library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use core::ops::{Index, IndexMut};

/// Uxn memory trait.
///
/// Needs to be implemented by any object that can be treated as a Uxn memory i.e.
/// take 16bit integers as addresses and return an 8bit unsigned integer.
///
/// Methods for handling shorts (16bit values) are given a default implementation
/// based on their 8bit counterparts.
///
/// It is automatically implemented for any type that can be indexed by `usize`,
/// such as typical arrays, slices, vectors, etc.
pub trait UxnMemory {
    /// Reads the content of memory at the given address.
    fn get(&self, address: u16) -> u8;

    /// Reads the content of memory at the given address as a short.
    fn get_short(&self, address: u16) -> u16 {
        u16::from_be_bytes([self.get(address), self.get(address.wrapping_add(1))])
    }

    /// Returns a mutable reference to the contents of memory at the given address.
    fn get_mut(&mut self, address: u16) -> &mut u8;

    /// Sets a short in memory at the given address.
    fn set_short(&mut self, address: u16, value: u16) {
        let [msb, lsb] = value.to_be_bytes();
        *self.get_mut(address) = msb;
        *self.get_mut(address.wrapping_add(1)) = lsb;
    }
}

impl<T: Index<usize, Output = u8> + IndexMut<usize>> UxnMemory for T {
    fn get(&self, address: u16) -> u8 {
        self[address as usize]
    }
    fn get_mut(&mut self, address: u16) -> &mut u8 {
        &mut self[address as usize]
    }
}