Struct musli_wire::encoding::WireEncoding

pub struct WireEncoding<I = Variable, L = Variable, const P: usize = MAX_INLINE_LEN> where
    I: TypedIntegerEncoding,
    L: TypedUsizeEncoding,  { /* private fields */ }

Setting up encoding with parameters.

Implementations

impl WireEncoding<Variable, Variable, MAX_INLINE_LEN>

pub const fn new() -> Self

Construct a new WireEncoding instance which uses Variable integer encoding.

You can modify this using the available factory methods:

use musli_wire::{WireEncoding, Fixed, Variable};
use musli::{Encode, Decode};

const CONFIG: WireEncoding<Fixed, Variable> = WireEncoding::new()
    .with_fixed_integers();

#[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);

impl<const P: usize, I, L> WireEncoding<I, L, P> where
    I: TypedIntegerEncoding,
    L: TypedUsizeEncoding, 

pub const fn with_variable_integers(self) -> WireEncoding<Variable, L, P>

Configure the encoding to use variable integer encoding.

pub const fn with_fixed_integers(self) -> WireEncoding<Fixed, L, P>

Configure the encoding to use fixed integer encoding.

pub const fn with_fixed_integers_le(
    self
) -> WireEncoding<Fixed<LittleEndian>, L, P>

Configure the encoding to use fixed integer little-endian encoding.

pub const fn with_fixed_integers_be(
    self
) -> WireEncoding<Fixed<BigEndian>, L, P>

Configure the encoding to use fixed integer big-endian encoding.

pub const fn with_fixed_integers_ne(
    self
) -> WireEncoding<Fixed<NetworkEndian>, L, P>

Configure the encoding to use fixed integer network-endian encoding (Default).

pub const fn with_variable_lengths(self) -> WireEncoding<I, Variable, P>

Configure the encoding to use variable length encoding.

pub const fn with_fixed_lengths(self) -> WireEncoding<I, FixedLength<u32>, P>

Configure the encoding to use fixed length 32-bit encoding when encoding lengths.

pub const fn with_fixed_lengths64(self) -> WireEncoding<I, FixedLength<u64>, P>

Configure the encoding to use fixed length 64-bit encoding when encoding lengths.

pub const fn with_max_pack<const N: usize>(self) -> WireEncoding<I, L, N>

Modify the maximum pack sized allowwed in the wire format. This defaults to MAX_INLINE_LEN, a value that will fit unencoded in the Tag of the type.

pub fn encode<W, T>(self, writer: W, value: &T) -> Result<(), W::Error> where
    W: Writer,
    T: ?Sized + Encode, 

Encode the given value to the given Writer using the current configuration.

pub fn to_writer<W, T>(self, write: W, value: &T) -> Result<(), Error> where
    W: Write,
    T: ?Sized + Encode, 

Encode the given value to the given Write using the current configuration.

pub fn to_vec<T>(self, value: &T) -> Result<Vec<u8>, VecWriterError> where
    T: ?Sized + Encode, 

Encode the given value to a Vec using the current configuration.

pub fn to_fixed_bytes<const N: usize, T>(
    self,
    value: &T
) -> Result<FixedBytes<N>, FixedBytesWriterError> where
    T: ?Sized + Encode, 

Encode the given value to a fixed-size bytes using the current configuration.

pub fn decode<'de, R, T>(self, reader: R) -> Result<T, R::Error> where
    R: Reader<'de>,
    T: Decode<'de>, 

Decode the given type T from the given Reader using the current configuration.

pub fn from_slice<'de, T>(self, bytes: &'de [u8]) -> Result<T, SliceReaderError> where
    T: Decode<'de>, 

Decode the given type T from the given slice using the current configuration.

Trait Implementations

impl<I: Clone, L: Clone, const P: usize> Clone for WireEncoding<I, L, P> where
    I: TypedIntegerEncoding,
    L: TypedUsizeEncoding, 

fn clone(&self) -> WireEncoding<I, L, P>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<I: Copy, L: Copy, const P: usize> Copy for WireEncoding<I, L, P> where
    I: TypedIntegerEncoding,
    L: TypedUsizeEncoding,