myrmic-common 0.7.0

Wire types shared across the Myrmic WASM host/guest boundary (db, cells, BLE, web), plus the host-only code generator behind myrmic-sdk-macros and the cell build tooling.
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
41
42
43
44
45
46
47
48

//! The JSON shapes the gateway's cell API accepts: events to publish and
//! commands to send, as posted by external clients.

/// One interaction an external client requests via the gateway, tagged by
/// `type`.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case", tag = "type")]
pub enum CellInteraction<'a> {
    /// Publish an event.
    Event(#[serde(borrow)] Event<'a>),
    /// Send a command to a cell.
    Command(#[serde(borrow)] Command<'a>),
}

/// An event name as sent over the gateway API.
pub type EventName = alloc::string::String;
/// A command name as sent over the gateway API.
pub type CommandName = alloc::string::String;
/// A raw payload as sent over the gateway API.
pub type Bytes = alloc::vec::Vec<u8>;

/// A request to publish an event.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[allow(missing_docs)]
pub struct Event<'a> {
    pub name: &'a str,
    /// The encoded event payload; `None` for payload-less events.
    pub payload: Option<&'a [u8]>,
}

/// A request to send a command to a cell.
#[derive(Debug, serde::Serialize, serde::Deserialize)]
#[allow(missing_docs)]
pub struct Command<'a> {
    pub sri: &'a str,
    pub name: &'a str,
    /// The encoded command payload; `None` for payload-less commands.
    pub payload: Option<&'a [u8]>,
}

/// Why an interaction was rejected, mapped onto an HTTP status.
#[derive(Debug)]
#[allow(missing_docs)]
pub struct Error {
    /// The HTTP status code to answer with.
    pub status: u16,
    pub message: &'static str,
}