Struct fadroma::bin_serde::ByteLen

pub struct ByteLen { /* private fields */ }

Used to encode the number of items that a sequence type (such as String::len or a Vec::len) has. This allows us to represent that length with as few bytes as possible while allowing it to be dynamic.

Implementations

impl ByteLen

pub const MAX: u32 = 268_435_455u32

pub const MAX_SIZE: usize = 4usize

The maximum size in bytes.

pub fn encode(len: usize) -> Result<Self>

Encodes the given length as bytes to be serialized. Returns an Error::ByteLenTooLong if the length is bigger than ByteLen::MAX.

pub fn as_bytes(&self) -> &[u8]

The raw bytes the represent the encoded length. The size of the slice is always between 1 and ByteLen::MAX_SIZE.

pub fn size(&self) -> usize

The size in bytes of the encoded length. Is always between 1 and ByteLen::MAX_SIZE.

pub fn decode(de: &mut Deserializer<'_>) -> Result<usize>

Decodes a length from a sequence of bytes as a usize. It relies on the bytes to have previously been encoded using ByteLen::encode and for the given Deserializer to be at the correct position at which those were written before. It is up to the implementor to ensure that these invariants hold true.

Trait Implementations

impl AsRef<[u8]> for ByteLen

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ByteLen

fn clone(&self) -> ByteLen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteLen

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

Formats the value using the given formatter.

impl Copy for ByteLen