Add postcard serde support

Signed-off-by: trivernis <trivernis@protonmail.com>
3 years ago · bb7534d333
parent 558a2cc6a7
commit bb7534d333
5 changed files with 300 additions and 11 deletions
--- a/Cargo.lock
+++ b/Cargo.lock
@ -2,6 +2,15 @@
 # It is not intended for manual editing.
 version = 3

+[[package]]
+name = "aho-corasick"
+version = "0.7.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e37cfd5e7657ada45f742d6e99ca5788580b5c529dc78faf11ece6dc702656f"
+dependencies = [
+ "memchr",
+]
+
 [[package]]
 name = "async-trait"
 version = "0.1.51"
@ -13,6 +22,16 @@ dependencies = [
 "syn",
 ]

+[[package]]
+name = "atomic-polyfill"
+version = "0.1.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e686d748538a32325b28d6411dd8a939e7ad5128e5d0023cc4fd3573db456042"
+dependencies = [
+ "critical-section",
+ "riscv-target",
+]
+
 [[package]]
 name = "atty"
 version = "0.2.14"
@ -30,6 +49,21 @@ version = "1.0.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a"

+[[package]]
+name = "bare-metal"
+version = "0.2.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5deb64efa5bd81e31fcd1938615a6d98c82eafcbcd787162b6f63b91d6bac5b3"
+dependencies = [
+ "rustc_version 0.2.3",
+]
+
+[[package]]
+name = "bare-metal"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f8fe8f5a8a398345e52358e18ff07cc17a568fbca5c6f73873d3a62056309603"
+
 [[package]]
 name = "bincode"
 version = "1.3.3"
@ -39,6 +73,18 @@ dependencies = [
 "serde",
 ]

+[[package]]
+name = "bit_field"
+version = "0.10.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "dcb6dd1c2376d2e096796e234a70e17e94cc2d5d54ff8ce42b28cef1d0d359a4"
+
+[[package]]
+name = "bitfield"
+version = "0.13.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "46afbd2983a5d5a7bd740ccb198caf5b82f45c40c09c0eed36052d91cb92e719"
+
 [[package]]
 name = "bitflags"
 version = "1.3.2"
@ -56,6 +102,7 @@ dependencies = [
 "crossbeam-utils",
 "futures",
 "lazy_static",
+ "postcard",
 "rmp-serde",
 "serde",
 "thiserror",
@ -100,7 +147,7 @@ version = "0.2.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "4c24dab4283a142afa2fdca129b80ad2c6284e073930f964c3a1293c225ee39a"
 dependencies = [
- "rustc_version",
+ "rustc_version 0.4.0",
 ]

 [[package]]
@ -120,6 +167,18 @@ dependencies = [
 "unicode-width",
 ]

+[[package]]
+name = "cortex-m"
+version = "0.7.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2ac919ef424449ec8c08d515590ce15d9262c0ca5f0da5b0c901e971a3b783b3"
+dependencies = [
+ "bare-metal 0.2.5",
+ "bitfield",
+ "embedded-hal",
+ "volatile-register",
+]
+
 [[package]]
 name = "criterion"
 version = "0.3.5"
@ -158,6 +217,18 @@ dependencies = [
 "itertools",
 ]

+[[package]]
+name = "critical-section"
+version = "0.2.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "01e191a5a6f6edad9b679777ef6b6c0f2bdd4a333f2ecb8f61c3e28109a03d70"
+dependencies = [
+ "bare-metal 1.0.0",
+ "cfg-if",
+ "cortex-m",
+ "riscv",
+]
+
 [[package]]
 name = "crossbeam-channel"
 version = "0.5.1"
@ -230,6 +301,16 @@ version = "1.6.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e78d4f1cc4ae33bbfc157ed5d5a5ef3bc29227303d595861deb238fcec4e9457"

+[[package]]
+name = "embedded-hal"
+version = "0.2.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e36cfb62ff156596c892272f3015ef952fe1525e85261fa3a7f327bd6b384ab9"
+dependencies = [
+ "nb 0.1.3",
+ "void",
+]
+
 [[package]]
 name = "futures"
 version = "0.3.18"
@ -325,6 +406,28 @@ version = "1.8.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "eabb4a44450da02c90444cf74558da904edde8fb4e9035a9a6a4e15445af0bd7"

+[[package]]
+name = "hash32"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b0c35f58762feb77d74ebe43bdbc3210f09be9fe6742234d573bacc26ed92b67"
+dependencies = [
+ "byteorder",
+]
+
+[[package]]
+name = "heapless"
+version = "0.7.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c1ad878e07405df82b695089e63d278244344f80e764074d0bdfe99b89460f3"
+dependencies = [
+ "atomic-polyfill",
+ "hash32",
+ "serde",
+ "spin",
+ "stable_deref_trait",
+]
+
 [[package]]
 name = "hermit-abi"
 version = "0.1.19"
@ -370,6 +473,15 @@ version = "0.2.108"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8521a1b57e76b1ec69af7599e75e38e7b7fad6610f037db8c79b127201b5d119"

+[[package]]
+name = "lock_api"
+version = "0.4.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712a4d093c9976e24e7dbca41db895dabcbac38eb5f4045393d17a95bdfb1109"
+dependencies = [
+ "scopeguard",
+]
+
 [[package]]
 name = "log"
 version = "0.4.14"
@ -416,6 +528,21 @@ dependencies = [
 "winapi",
 ]

+[[package]]
+name = "nb"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "801d31da0513b6ec5214e9bf433a77966320625a37860f910be265be6e18d06f"
+dependencies = [
+ "nb 1.0.0",
+]
+
+[[package]]
+name = "nb"
+version = "1.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "546c37ac5d9e56f55e73b677106873d9d9f5190605e41a856503623648488cae"
+
 [[package]]
 name = "ntapi"
 version = "0.3.6"
@ -490,6 +617,23 @@ dependencies = [
 "plotters-backend",
 ]

+[[package]]
+name = "postcard"
+version = "0.7.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c8863e251332eb18520388099b8b0acc4810ed6e602e3b6f674e8a46ba20e15c"
+dependencies = [
+ "heapless",
+ "postcard-cobs",
+ "serde",
+]
+
+[[package]]
+name = "postcard-cobs"
+version = "0.1.5-pre"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7c68cb38ed13fd7bc9dd5db8f165b7c8d9c1a315104083a2b10f11354c2af97f"
+
 [[package]]
 name = "proc-macro2"
 version = "1.0.32"
@ -539,6 +683,8 @@ version = "1.5.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d07a8629359eb56f1e2fb1652bb04212c072a87ba68546a04065d525673ac461"
 dependencies = [
+ "aho-corasick",
+ "memchr",
 "regex-syntax",
 ]

@ -554,6 +700,27 @@ version = "0.6.25"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f497285884f3fcff424ffc933e56d7cbca511def0c9831a7f9b5f6153e3cc89b"

+[[package]]
+name = "riscv"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6907ccdd7a31012b70faf2af85cd9e5ba97657cc3987c4f13f8e4d2c2a088aba"
+dependencies = [
+ "bare-metal 1.0.0",
+ "bit_field",
+ "riscv-target",
+]
+
+[[package]]
+name = "riscv-target"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "88aa938cda42a0cf62a20cfe8d139ff1af20c2e681212b5b34adb5a58333f222"
+dependencies = [
+ "lazy_static",
+ "regex",
+]
+
 [[package]]
 name = "rmp"
 version = "0.8.10"
@ -575,13 +742,22 @@ dependencies = [
 "serde",
 ]

+[[package]]
+name = "rustc_version"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "138e3e0acb6c9fb258b19b67cb8abd63c00679d2851805ea151465464fe9030a"
+dependencies = [
+ "semver 0.9.0",
+]
+
 [[package]]
 name = "rustc_version"
 version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bfa0f585226d2e68097d4f95d113b15b83a82e819ab25717ec0590d9584ef366"
 dependencies = [
- "semver",
+ "semver 1.0.4",
 ]

 [[package]]
@ -605,12 +781,27 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"

+[[package]]
+name = "semver"
+version = "0.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1d7eb9ef2c18661902cc47e535f9bc51b78acd254da71d375c2f6720d9a40403"
+dependencies = [
+ "semver-parser",
+]
+
 [[package]]
 name = "semver"
 version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "568a8e6258aa33c13358f81fd834adb854c6f7c9468520910a9b1e8fac068012"

+[[package]]
+name = "semver-parser"
+version = "0.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "388a1df253eca08550bef6c72392cfe7c30914bf41df5269b68cbd6ff8f570a3"
+
 [[package]]
 name = "serde"
 version = "1.0.130"
@ -658,6 +849,21 @@ version = "0.4.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "9def91fd1e018fe007022791f865d0ccc9b3a0d5001e01aabb8b40e46000afb5"

+[[package]]
+name = "spin"
+version = "0.9.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "511254be0c5bcf062b019a6c89c01a664aa359ded62f78aa72c6fc137c0590e5"
+dependencies = [
+ "lock_api",
+]
+
+[[package]]
+name = "stable_deref_trait"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3"
+
 [[package]]
 name = "syn"
 version = "1.0.82"
@ -786,6 +992,27 @@ version = "0.2.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8ccb82d61f80a663efe1f787a51b16b5a51e3314d6ac365b08639f52387b33f3"

+[[package]]
+name = "vcell"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "77439c1b53d2303b20d9459b1ade71a83c716e3f9c34f3228c00e6f185d6c002"
+
+[[package]]
+name = "void"
+version = "1.0.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6a02e4885ed3bc0f2de90ea6dd45ebcbb66dacffe03547fadbb0eeae2770887d"
+
+[[package]]
+name = "volatile-register"
+version = "0.2.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9ee8f19f9d74293faf70901bc20ad067dc1ad390d2cbf1e3f75f721ffee908b6"
+dependencies = [
+ "vcell",
+]
+
 [[package]]
 name = "walkdir"
 version = "2.3.2"
--- a/Cargo.toml
+++ b/Cargo.toml
@ -39,6 +39,11 @@ features = []
 version = "1.12.0"
 features = ["net", "io-std", "io-util", "sync", "time"]

+[dependencies.postcard]
+version = "0.7.2"
+optional = true
+features = ["alloc"]
+
 [dev-dependencies]
 rmp-serde = "0.15.4"
 crossbeam-utils = "0.8.5"
@ -59,4 +64,5 @@ features = ["macros", "rt-multi-thread"]
 default = []
 serialize = ["serde"]
 serialize_rmp = ["serialize", "rmp-serde"]
-serialize_bincode = ["serialize", "bincode"]
+serialize_bincode = ["serialize", "bincode"]
+serialize_postcard = ["serialize", "postcard"]
--- a/src/events/payload_serializer/mod.rs
+++ b/src/events/payload_serializer/mod.rs
@ -1,5 +1,5 @@
 #[cfg(feature = "serialize_rmp")]
-pub mod serialize_rmp;
+mod serialize_rmp;

 #[cfg(feature = "serialize_rmp")]
 pub use serialize_rmp::*;
@ -8,4 +8,10 @@ pub use serialize_rmp::*;
 mod serialize_bincode;

 #[cfg(feature = "serialize_bincode")]
-pub use serialize_bincode::*;
+pub use serialize_bincode::*;
+
+#[cfg(feature = "serialize_postcard")]
+mod serialize_postcard;
+
+#[cfg(feature = "serialize_postcard")]
+pub use serialize_postcard::*;
--- a/src/events/payload_serializer/serialize_postcard.rs
+++ b/src/events/payload_serializer/serialize_postcard.rs
@ -0,0 +1,32 @@
+use crate::payload::{EventReceivePayload, EventSendPayload};
+use crate::prelude::IPCResult;
+use serde::de::DeserializeOwned;
+use serde::Serialize;
+use std::io::Read;
+
+pub type SerializationError = postcard::Error;
+
+impl<T> EventSendPayload for T
+where
+    T: Serialize,
+{
+    fn to_payload_bytes(self) -> IPCResult<Vec<u8>> {
+        let bytes = postcard::to_allocvec(&self)?.to_vec();
+
+        Ok(bytes)
+    }
+}
+
+impl<T> EventReceivePayload for T
+where
+    T: DeserializeOwned,
+{
+    fn from_payload_bytes<R: Read>(mut reader: R) -> IPCResult<Self> {
+        let mut buf = Vec::new();
+        // reading to end means reading the full size of the provided data
+        reader.read_to_end(&mut buf)?;
+        let type_data = postcard::from_bytes(&buf)?;
+
+        Ok(type_data)
+    }
+}
--- a/src/lib.rs
+++ b/src/lib.rs
@ -101,13 +101,31 @@
 //! # }
 //! ```

-#[cfg(all(feature = "serialize", not(any(feature = "serialize_bincode", feature = "serialize_rmp"))))]
-compile_error!("Feature 'serialize' cannot be used by its own. Choose one of 'serialize_rmp', 'serialize_rmp' instead.");
+#[cfg(all(
+    feature = "serialize",
+    not(any(
+        feature = "serialize_bincode",
+        feature = "serialize_rmp",
+        feature = "serialize_postcard"
+    ))
+))]
+compile_error!("Feature 'serialize' cannot be used by its own. Choose one of 'serialize_rmp', 'serialize_bincode', 'serialize_postcard' instead.");

-#[cfg(all(feature = "serialize_rmp", feature = "serialize_bincode"))]
-compile_error!(
-    "Feature 'serialize_rmp' and 'serialize_bincode' cannot be enabled at the same time"
-);
+#[cfg(any(
+    all(
+        feature = "serialize_rmp",
+        any(feature = "serialize_postcard", feature = "serialize_bincode")
+    ),
+    all(
+        feature = "serialize_bincode",
+        any(feature = "serialize_rmp", feature = "serialize_postcard")
+    ),
+    all(
+        feature = "serialize_postcard",
+        any(feature = "serialize_rmp", feature = "serialize_bincode")
+    )
+))]
+compile_error!("You cannot use two serialize_* features at the same time");

 pub mod error;
 mod events;