Module wire

Available on crate feature wire only.

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.

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<u32>,
}

let version2 = musli::wire::to_vec(&Version2 {
    name: String::from("Aristotle"),
    age: Some(61),
})?;

let version1: Version1 = musli::wire::decode(version2.as_slice())?;

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

Configuring

To configure the behavior of the wire format you can use the Encoding type:

use musli::{Encode, Decode};
use musli::options::{self, Options, Integer};
use musli::wire::Encoding;

const OPTIONS: Options = options::new().with_integer(Integer::Fixed).build();
const CONFIG: Encoding<OPTIONS> = Encoding::new().with_options();

#[derive(Debug, PartialEq, Encode, Decode)]
struct Person<'a> {
    name: &'a str,
    age: u32,
}

let mut out = Vec::new();

let expected = Person {
    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.

Structs

• Encoding
  Setting up encoding with parameters.
• Error
  Error raised during descriptive encoding.

Constants

• DEFAULT
  The default configuration.
• OPTIONS
  The default flavor used by the DEFAULT configuration.

Functions

• decode
  Decode the given type T from the given Reader using the DEFAULT Encoding.
• encode
  Encode the given value to the given Writer using the DEFAULT Encoding.
• from_slice
  Decode the given type T from the given slice using the DEFAULT Encoding.
• to_fixed_bytes
  Encode the given value to a fixed-size bytes using the DEFAULT Encoding.
• to_slice
  Encode the given value to the given slice using the DEFAULT Encoding and return the number of bytes encoded.
• to_vecalloc
  Encode the given value to a Vec using the DEFAULT Encoding.
• to_writerstd
  Encode the given value to the given Write using the DEFAULT Encoding.

Type Aliases

• Result
  Convenient result alias for use with musli::wire.