From 5b0ecb6d274777154a63461019374c742df54f9e Mon Sep 17 00:00:00 2001 From: nworbnhoj Date: Wed, 6 Apr 2022 07:26:40 +1000 Subject: [PATCH] link to rkyv & bincode in API.md --- API.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/API.md b/API.md index d6e6c9d9f..556080415 100644 --- a/API.md +++ b/API.md @@ -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