Struct Bincode

pub struct Bincode<E = LittleEndian, I = Varint, L = NoLimit> {
    pub configuration: Configuration<E, I, L>,
}

Available on crate feature bincode only.

A FileFormat corresponding to the CBOR binary data format. Implemented using the ciborium crate, only compatible with types that implement Decode and Encode.

Fields

configuration: Configuration<E, I, L>

The internal Configuration.

Implementations

impl<E, I, L> Bincode<E, I, L>

pub const fn new(configuration: Configuration<E, I, L>) -> Self

Creates a new Bincode given a Configuration.

pub const fn with_big_endian(self) -> Bincode<BigEndian, I, L>

Makes bincode encode all integer types in big endian.

Applies with_big_endian to the wrapped Configuration.

pub const fn with_little_endian(self) -> Bincode<LittleEndian, I, L>

Makes bincode encode all integer types in little endian.

Applies with_little_endian to the wrapped Configuration.

pub const fn with_variable_int_encoding(self) -> Bincode<E, Varint, L>

Makes bincode encode all integer types with a variable integer encoding.

Applies with_variable_int_encoding to the wrapped Configuration.

pub const fn with_fixed_int_encoding(self) -> Bincode<E, Fixint, L>

Fixed-size integer encoding.

Applies with_fixed_int_encoding to the wrapped Configuration.

pub const fn with_limit<const N: usize>(self) -> Bincode<E, I, Limit<N>>

Sets the byte limit to limit.

Applies with_limit to the wrapped Configuration.

pub const fn with_no_limit(self) -> Bincode<E, I, NoLimit>

Clear the byte limit.

Applies with_no_limit to the wrapped Configuration.

Trait Implementations

impl<E: Clone, I: Clone, L: Clone> Clone for Bincode<E, I, L>

fn clone(&self) -> Bincode<E, I, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug, I: Debug, L: Debug> Debug for Bincode<E, I, L>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: Default, I: Default, L: Default> Default for Bincode<E, I, L>

fn default() -> Bincode<E, I, L>

Returns the “default value” for a type.

impl<T, E, I, L> FileFormat<T> for Bincode<E, I, L>

where T: Decode<()> + Encode, Configuration<E, I, L>: Config,

type FormatError = BincodeError

The type of error to return from to_writer and from_reader.

fn from_reader<R: Read>(&self, reader: R) -> Result<T, Self::FormatError>

Deserialize a value from a Read stream.

fn from_buffer(&self, buf: &[u8]) -> Result<T, Self::FormatError>

Deserialize a value from a byte vec.

fn to_writer<W: Write>( &self, writer: W, value: &T, ) -> Result<(), Self::FormatError>

Serialize a value into a Write stream.

fn to_buffer(&self, value: &T) -> Result<Vec<u8>, Self::FormatError>

Serialize a value into a byte vec.

fn from_reader_buffered<R>(&self, reader: R) -> Result<T, Self::FormatError>

where R: Read,

Identical to FileFormat::from_reader, however the provided reader is buffered with BufReader.

fn to_writer_buffered<W>( &self, writer: W, value: &T, ) -> Result<(), Self::FormatError>

where W: Write,

Identical to FileFormat::to_writer, however the provided writer is buffered with BufWriter.

impl<E: Copy, I: Copy, L: Copy> Copy for Bincode<E, I, L>