14 releases
new 0.5.0 | Mar 18, 2023 |
---|---|
0.4.2 | Jan 25, 2022 |
0.4.1 | Jul 29, 2021 |
0.3.1 | Jun 21, 2021 |
0.1.6 | Jun 12, 2021 |
#158 in Encoding
746 downloads per month
75KB
2K
SLoC
msgpack-schema

msgpack-schema is a schema language for describing data formats encoded in MessagePack.
It provides two derive macros Serialize
and Deserialize
that allow you to transcode MessagePack binary data to/from Rust data structures in a type-directed way.
use msgpack_schema::{Deserialize, Serialize};
#[derive(Deserialize, Serialize)]
struct Human {
#[tag = 0]
name: String,
#[tag = 2]
#[optional]
age: Option<u32>,
}
Behaviours of serializers and deserializers
Some general rules
- The deserializer ignores irrelevant key-value pairs in MsgPack map objects.
- MsgPack map objects must not have duplicate keys.
Structs with named fields
Structs with named fields will be serialized into a MsgPack map object whose keys are fixints specified by #[tag]
attributes.
schema | Rust | MessagePack |
---|---|---|
|
|
|
Fields in named structs may be tagged with #[optional]
.
- The tagged field must be of type
Option<T>
. - On serialization, the key-value pair will not be included in the result map object when the field data contains
None
. - On deserialization, the field of the result struct will be filled with
None
when the given MsgPack map object contains no corresponding key-value pair.
The #[flatten]
attribute is used to factor out a single definition of named struct into multiple ones.
# use msgpack_schema::*;
#[derive(Serialize)]
struct S1 {
#[tag = 1]
x: u32,
}
#[derive(Serialize)]
struct S2 {
#[flatten]
s1: S1,
#[tag = 2]
y: u32,
}
#[derive(Serialize)]
struct S3 {
#[tag = 1]
x: u32,
#[tag = 2]
y: u32,
}
assert_eq!(serialize(S2 { s1: S1 { x: 42 }, y: 43, }), serialize(S3 { x: 42, y: 43 }));
Untagged structs with named fields
Structs with named fields may be attached #[untagged]
.
Untagged structs are serialized into an array and will not contain tags.
schema | Rust | MessagePack |
---|---|---|
|
|
|
Newtype structs
Tuple structs with only one element are treated transparently.
schema | Rust | MessagePack |
---|---|---|
|
|
|
Unit structs and empty tuple structs
Serialization and deserialization of unit structs and empty tuple structs are currently unsupported.
schema | Rust | MessagePack |
---|---|---|
|
|
UNSUPPORTED |
|
|
UNSUPPORTED |
Tuple structs
Tuple structs with more than one element are encoded as an array.
schema | Rust | MessagePack |
---|---|---|
|
|
|
Unit variants and empty tuple variants
Unit variants and empty tuple variants are serialized into a single fixint whose value is determined by the tag.
schema | Rust | MessagePack |
---|---|---|
|
|
|
|
|
|
Newtype variants
Newtype variants (one-element tuple variants) are serialized into an array of the tag and the inner value.
schema | Rust | MessagePack |
---|---|---|
|
|
|
Untagged variants
Enums may be attached #[untagged]
when all variants are newtype variants.
Serializing untagged variants results in the same data layout as the inner type.
The deserializer deserializes into an untagged enum type by trying deserization one by one from the first variant to the last.
schema | Rust | MessagePack |
---|---|---|
|
|
|
License
Licensed under MIT license.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in msgpack-schema by you shall be licensed as above, without any additional terms or conditions.
Dependencies
~3.5MB
~69K SLoC