Trait FixedWidthEncoding

pub trait FixedWidthEncoding {
    type Decode;

    // Required methods
    fn fw_encoded_size(&self) -> Result<usize, EncodingError>;
    fn fw_encode<'a>(
        &self,
        buffer: &'a mut [u8],
    ) -> Result<&'a mut [u8], EncodingError>;
    fn fw_decode(buffer: &[u8]) -> Result<(Self::Decode, &[u8]), EncodingError>
       where Self: Sized;

    // Provided method
    fn as_fixed_width(&self) -> FixedWidthUint<'_, Self> { ... }
}

Implents functionality needed to encode unisegned integrer in a fixed width way with CompactEncoding

Required Associated Types

type Decode

The type we decode to

Required Methods

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

The size in bytes required to encode self.

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

Encode self into buffer returning the remainder of buffer.

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

where Self: 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 as_fixed_width(&self) -> FixedWidthUint<'_, Self>

Get a uint in a form that encodes to a fixed width

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 FixedWidthEncoding for u32

type Decode = u32

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

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

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

where Self: Sized,

impl FixedWidthEncoding for u64

type Decode = u64

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

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

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

where Self: Sized,

Implementors