Struct Encoding

pub struct Encoding<Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> { /* private fields */ }

Base-conversion encoding.

See Specification for technical details or how to define a new one.

Implementations

impl<Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> Encoding<Bit, Msb, Pad, Wrap, Ignore>

pub fn encode_len(&self, len: usize) -> usize

Returns the encoded length of an input of length len.

See Self::encode_mut() for when to use it.

pub fn encode_mut_uninit<'a>( &self, input: &[u8], output: &'a mut [MaybeUninit<u8>], ) -> &'a mut [u8]

Encodes input in output.

Panics

Panics if the output length does not match the result of Self::encode_len() for the input length.

pub fn encode_mut(&self, input: &[u8], output: &mut [u8])

Encodes input in output.

Panics

Panics if the output length does not match the result of Self::encode_len() for the input length.

pub fn encode_append(&self, input: &[u8], output: &mut String)

Available on crate feature alloc only.

Appends the encoding of input to output.

pub fn encode_write_buffer_uninit( &self, input: &[u8], output: &mut impl Write, buffer: &mut [MaybeUninit<u8>], ) -> Result

Writes the encoding of input to output using a temporary buffer.

Panics

Panics if the buffer is shorter than 510 bytes.

Errors

Returns an error when writing to the output fails.

pub fn encode_write_buffer( &self, input: &[u8], output: &mut impl Write, buffer: &mut [u8], ) -> Result

Writes the encoding of input to output using a temporary buffer.

Panics

Panics if the buffer is shorter than 510 bytes.

Errors

Returns an error when writing to the output fails.

pub fn encode_write(&self, input: &[u8], output: &mut impl Write) -> Result

Writes the encoding of input to output.

This allocates a buffer of 1024 bytes on the stack. If you want to control the buffer size and location, use Self::encode_write_buffer() instead.

Errors

Returns an error when writing to the output fails.

pub fn encode(&self, input: &[u8]) -> String

Available on crate feature alloc only.

Returns encoded input.

pub fn decode_len(&self, len: usize) -> Result<usize, DecodeError>

Returns the decoded length of an input of length len.

See Self::decode_mut() for when to use it.

Errors

Returns an error if len is invalid. The error kind is DecodeKind::Length and the error position is the greatest valid input length.

pub fn decode_mut_uninit<'a>( &self, input: &[u8], output: &'a mut [MaybeUninit<u8>], ) -> Result<&'a mut [u8], DecodePartial>

Decodes input in output.

Returns the decoded output. Its length may be smaller than the output length if the input contained padding or ignored characters. The output bytes after the returned length are not initialized and should not be read.

Panics

Panics if the output length does not match the result of Self::decode_len() for the input length. Also panics if decode_len fails for the input length.

Errors

Returns an error if input is invalid. See Self::decode_mut() for more details.

pub fn decode_mut( &self, input: &[u8], output: &mut [u8], ) -> Result<usize, DecodePartial>

Decodes input in output.

Returns the length of the decoded output. This length may be smaller than the output length if the input contained padding or ignored characters. The output bytes after the returned length are not initialized and should not be read.

Panics

Panics if the output length does not match the result of Self::decode_len() for the input length. Also panics if decode_len fails for the input length.

Errors

Returns an error if input is invalid. See Self::decode() for more details. The are two differences though:

• DecodeKind::Length may be returned only if the encoding allows ignored characters, because otherwise this is already checked by Self::decode_len().
• The DecodePartial::read first bytes of the input have been successfully decoded to the DecodePartial::written first bytes of the output.

pub fn decode(&self, input: &[u8]) -> Result<Vec<u8>, DecodeError>

Available on crate feature alloc only.

Returns decoded input.

Errors

Returns an error if input is invalid. The error kind can be:

• DecodeKind::Length if the input length is invalid. The position is the greatest valid input length.
• DecodeKind::Symbol if the input contains an invalid character. The position is the first invalid character.
• DecodeKind::Trailing if the input has non-zero trailing bits. This is only possible if the encoding checks trailing bits. The position is the first character containing non-zero trailing bits.
• DecodeKind::Padding if the input has an invalid padding length. This is only possible if the encoding uses padding. The position is the first padding character of the first padding of invalid length.

pub fn specification(&self) -> Specification

Available on crate feature alloc only.

TODO

pub fn as_dyn(&self) -> &DynEncoding

TODO

Trait Implementations

impl<Bit: Clone + BitWidth, Msb: Clone + Bool, Pad: Clone + Bool, Wrap: Clone + Bool, Ignore: Clone + Bool> Clone for Encoding<Bit, Msb, Pad, Wrap, Ignore>

fn clone(&self) -> Encoding<Bit, Msb, Pad, Wrap, Ignore>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Bit: Debug + BitWidth, Msb: Debug + Bool, Pad: Debug + Bool, Wrap: Debug + Bool, Ignore: Debug + Bool> Debug for Encoding<Bit, Msb, Pad, Wrap, Ignore>

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

Formats the value using the given formatter.

impl<'a, Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> From<&'a Encoding<Bit, Msb, Pad, Wrap, Ignore>> for &'a DynEncoding

fn from(base: &'a Encoding<Bit, Msb, Pad, Wrap, Ignore>) -> Self

Converts to this type from the input type.

impl<Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> From<Encoding<Bit, Msb, Pad, Wrap, Ignore>> for DynEncoding

fn from(base: Encoding<Bit, Msb, Pad, Wrap, Ignore>) -> Self

Converts to this type from the input type.

impl<Bit: PartialEq + BitWidth, Msb: PartialEq + Bool, Pad: PartialEq + Bool, Wrap: PartialEq + Bool, Ignore: PartialEq + Bool> PartialEq for Encoding<Bit, Msb, Pad, Wrap, Ignore>

fn eq(&self, other: &Encoding<Bit, Msb, Pad, Wrap, Ignore>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> TryFrom<&'a DynEncoding> for &'a Encoding<Bit, Msb, Pad, Wrap, Ignore>

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(base: &'a DynEncoding) -> Result<Self, Self::Error>

Performs the conversion.

impl<Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> TryFrom<DynEncoding> for Encoding<Bit, Msb, Pad, Wrap, Ignore>

type Error = ConvertError

The type returned in the event of a conversion error.

fn try_from(base: DynEncoding) -> Result<Self, Self::Error>

Performs the conversion.

impl<Bit: Eq + BitWidth, Msb: Eq + Bool, Pad: Eq + Bool, Wrap: Eq + Bool, Ignore: Eq + Bool> Eq for Encoding<Bit, Msb, Pad, Wrap, Ignore>

impl<Bit: BitWidth, Msb: Bool, Pad: Bool, Wrap: Bool, Ignore: Bool> StructuralPartialEq for Encoding<Bit, Msb, Pad, Wrap, Ignore>