Struct commune::Device

pub struct Device {
    pub id: u16,
    pub rx: ArrayVec<[Frame; 64]>,
    pub tx: ArrayVec<[Frame; 64]>,
    pub scratch: [u8; 1536],
}

Represents a single transceiver

Fields

id: u16

The ID of this device

rx: ArrayVec<[Frame; 64]>

tx: ArrayVec<[Frame; 64]>

scratch: [u8; 1536]

Scratch buffer shared between RX and TX for easier mutations.

Implementations

impl Device

pub fn new(id: u16) -> Self

pub fn serialize<T>(&mut self, rx_id: u16, data: &T) -> Result<(), Error> where
    T: Serialize, 

Serialize data to the TX buffer via CBOR in preperation for sending across a radio or wire. This overwrites anything currently in the TX buffer without warning.

Arguments

• rx_id - The intended receiving ID
• data - Arbitrary data to serialize

Examples

let mut device = Device::new(1);

// Serialize the number 69 to our TX buffer, targeting another device with the ID of 0.
device.serialize(0, &69);

// We can also serialize anything implementing serde's Serialize trait.
#[derive(Serialize)]
pub struct MyData<'a> {
    name: &'a str,
    age: usize,
}

// Serialize this data TX buffer, targeting another device with the ID of 0. Our receiving device
// will need to know beforehand the data structure.
let data = MyData { name: &"Karl", age: 32 };
device.serialize(0, &data);

pub fn deserialize<'de, T>(&'de mut self) -> Result<T, Error> where
    T: Deserialize<'de>, 

Takes the contents of the RX buffer and deserializes it to type T.