link to rkyv & bincode in API.md

This commit is contained in:
nworbnhoj 2022-04-06 07:26:40 +10:00 committed by GitHub
parent cd9a1a90ff
commit 5b0ecb6d27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

4
API.md
View file

@ -1,6 +1,10 @@
## Xous Messaging API In Practice
All Messages passed between Xous Servers undergo serialization and de-serialization.
- Internal `struct` are readily serialized with [rkyv](https://docs.rs/rkyv/0.7.37/rkyv/) and `#[derive(Debug, num_derive::FromPrimitive, num_derive::ToPrimitive)]`with manual serialization as an alternative ([example](services/net/src/std_udp.rs))
- External `struct` may employ [bincode](https://docs.rs/bincode/latest/bincode/)
Here are the idioms for building servers and passing messages.
### api.rs