Trait CompactEncoding

pub trait CompactEncoding<Decode: ?Sized = Self> {
    // Required methods
    fn encoded_size(&self) -> Result<usize, EncodingError>;
    fn encode<'a>(
        &self,
        buffer: &'a mut [u8],
    ) -> Result<&'a mut [u8], EncodingError>;
    fn decode(buffer: &[u8]) -> Result<(Decode, &[u8]), EncodingError>
       where Decode: Sized;

    // Provided methods
    fn to_encoded_bytes(&self) -> Result<Box<[u8]>, EncodingError> { ... }
    fn create_buffer(&self) -> Result<Box<[u8]>, EncodingError> { ... }
    fn encode_with_len<'a>(
        &self,
        buffer: &'a mut [u8],
    ) -> Result<(&'a mut [u8], usize), EncodingError> { ... }
    fn decode_with_len(
        buffer: &[u8],
    ) -> Result<(Decode, &[u8], usize), EncodingError>
       where Decode: Sized { ... }
}

A trait for building small and fast parsers and serializers.

Required Methods

fn encoded_size(&self) -> Result<usize, EncodingError>

The size in bytes required to encode self.

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

Encode self into buffer returning the remainder of buffer.

fn decode(buffer: &[u8]) -> Result<(Decode, &[u8]), EncodingError>

where Decode: Sized,

Decode a value from the given buffer of the type specified by the Decode type parameter (which defaults to Self). Returns the decoded value and remaining undecoded bytes.

Provided Methods

fn to_encoded_bytes(&self) -> Result<Box<[u8]>, EncodingError>

Encode self into a Vec<u8>. This is just a helper method for creating a buffer and encoding to it in one step.

let foo: Ipv4Addr = "0.0.0.0".parse()?;
let mut buff = vec![0; foo.encoded_size()?];
foo.encode(&mut buff)?;

fn create_buffer(&self) -> Result<Box<[u8]>, EncodingError>

Create an empty buffer of the correct size for encoding self to. This is just a helper method for: encoding to it in one step.

let foo: Ipv4Addr = "0.0.0.0".parse()?;
vec![0; foo.encoded_size()?];

fn encode_with_len<'a>( &self, buffer: &'a mut [u8], ) -> Result<(&'a mut [u8], usize), EncodingError>

Like CompactEncoding::encode but also return the number of bytes encoded.

fn decode_with_len( buffer: &[u8], ) -> Result<(Decode, &[u8], usize), EncodingError>

where Decode: Sized,

Like CompactEncoding::decode but also return the number of bytes decoded.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl CompactEncoding for u8

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for u16

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for u32

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for u64

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for String

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for Vec<u8>

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for Vec<String>

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for Ipv4Addr

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding for Ipv6Addr

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl CompactEncoding<String> for str

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(String, &[u8]), EncodingError>

impl<T: BoxedSliceEncodable> CompactEncoding for Box<[T]>

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl<T: VecEncodable> CompactEncoding for Vec<T>

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

impl<const N: usize> CompactEncoding for [u8; N]

fn encoded_size(&self) -> Result<usize, EncodingError>

fn encode<'a>( &self, buffer: &'a mut [u8], ) -> Result<&'a mut [u8], EncodingError>

fn decode(buffer: &[u8]) -> Result<(Self, &[u8]), EncodingError>

where Self: Sized,

Implementors

impl<T: FixedWidthEncoding> CompactEncoding<<T as FixedWidthEncoding>::Decode> for FixedWidthUint<'_, T>