Trait Encoder

pub trait Encoder {
    type Error;

    // Required methods
    fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>;
    fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>;
}

A type that can handle an Encodable type

An encoder is responsible for writing bytes into a buffer or other destination. Encoders are used by encodables to write their data. Thus, encoders must uphold the same properties as encodables.

Required Associated Types

type Error

The error type that can be returned when encoding a value.

For example, some encoders may return an error if the underlying buffer is full

Required Methods

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

Copies a slice of bytes into the encoder

Errors

Implementations of this method should return an error if the underlying encoder fails to write the slice of bytes.

fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>

Appends a single byte into the encoder, if possible.

Errors

Implementations of this method should return an error if the underlying encoder fails to write the byte.

Implementations on Foreign Types

impl Encoder for &mut [u8]

type Error = InsufficientSpace

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>

impl Encoder for ()

type Error = Infallible

fn put_slice(&mut self, _: &[u8]) -> Result<(), Self::Error>

fn put_byte(&mut self, _: u8) -> Result<(), Self::Error>

impl Encoder for Vec<u8>

type Error = Infallible

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>

impl Encoder for BytesMut

type Error = Infallible

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>

impl<const SIZE: usize> Encoder for ArrayVec<u8, SIZE>

type Error = InsufficientSpace

fn put_slice(&mut self, slice: &[u8]) -> Result<(), Self::Error>

fn put_byte(&mut self, byte: u8) -> Result<(), Self::Error>

Implementors

impl Encoder for SizeEncoder

type Error = Infallible