musli-wire

Fully upgrade stable format for [Müsli] suitable for network communication.

Wire encoding is fully upgrade stable:

• ✔ Can tolerate missing fields if they are annotated with #[musli(default)].
• ✔ Can skip over unknown fields.

This means that it's suitable as a wire format, since the data model can evolve independently among clients. Once some clients are upgraded they will start sending unknown fields which non-upgraded clients will be forced to skip over for the duration of the upgrade.

```rust use musli::{Encode, Decode};

[derive(Debug, PartialEq, Encode, Decode)]

struct Version1 { name: String, }

[derive(Debug, PartialEq, Encode, Decode)]

struct Version2 { name: String, #[musli(default)] age: Option, }

let version2 = musliwire::tovec(&Version2 { name: String::from("Aristotle"), age: Some(62), })?;

let version1: Version1 = musli_wire::decode(&version2[..])?;

assert_eq!(version1, Version1 { name: String::from("Aristotle"), }); ```

Configuring

To configure the behavior of the [simple] format you can use the [WireEncoding] type:

```rust use musliwire::WireEncoding; use musliwire::{Fixed, Variable}; use musli::{Encode, Decode};

const CONFIG: WireEncoding = WireEncoding::new() .withfixedintegers();

[derive(Debug, PartialEq, Encode, Decode)]

struct Struct<'a> { name: &'a str, age: u32, }

let mut out = Vec::new();

let expected = Struct { name: "Aristotle", age: 61, };

CONFIG.encode(&mut out, &expected)?; let actual = CONFIG.decode(&out[..])?;

assert_eq!(expected, actual); ```

Implementation details

Each field is prefix typed with a single byte tag that allows a receiver to figure out exactly how much should be skipped over.

The types available are defined in the [types] module.

License: MIT/Apache-2.0