enum2contract
is a no_std compatible rust derive macro that lets users specify contracts for pub/sub style messaging using strongly typed rust enums.
Conversion methods for JSON and binary are created for the generated payloads.
Add this to your Cargo.toml
:
toml
enum2contract = "0.1.6"
serde = { version = "1.0.158", default-features = false, features = ["derive"] }
serde_json = { version = "1.0.94", default-features = false, features = ["alloc"] }
postcard = { version = "1.0.4", features = ["alloc"] }
Example:
```rust use enum2contract::EnumContract; use serde::{Deserialize, Serialize};
pub enum Message { #[topic("notify/{group}")] Notify,
#[topic("notify_all")]
NotifyAll,
#[topic("system/{id}/start/{mode}")]
Start { immediate: bool, timeout: u64 },
}
fn topic() { asserteq!(Message::notifytopic("subset"), "notify/subset");
assert_eq!(Message::notify_all_topic(), "notify_all");
assert_eq!(
Message::start_topic(&3.to_string(), "idle"),
"system/3/start/idle"
);
}
fn message() { asserteq!( Message::notify("subgroup"), ("notify/subgroup".tostring(), NotifyPayload::default()) );
assert_eq!(
Message::notify_all(),
("notify_all".to_string(), NotifyAllPayload::default())
);
assert_eq!(
Message::start(&3.to_string(), "idle"),
("system/3/start/idle".to_string(), StartPayload::default())
);
}
fn notifypayloadfromjsonwithdata() { let json = r#"{"immediate":true,"timeout":40}"#; let payload = StartPayload::fromjson(json).unwrap(); assert_eq!( payload, StartPayload { immediate: true, timeout: 40, } ); } ```
This crate is
#![no_std]
compatible but requiresalloc
.