Struct Record

pub struct Record<Len: LenType, T> {
    pub data: T,
    /* private fields */
}

Record can be used to encode collections where the size of the length is known.

For example, Record<u8, String> here the maximum allowed payload length is 255 (u8::MAX)

Example

use bin_layout::*;

let record: Record<u8, String> = "very long string!".repeat(15).into();
let bytes = record.encode();
assert_eq!(record.len(), 255);
assert_eq!(bytes.len(), 256);

Fields

data: T

Implementations

impl<Len: LenType, T> Record<Len, T>

pub const fn new(data: T) -> Self

Trait Implementations

impl<Len: Clone + LenType, T: Clone> Clone for Record<Len, T>

fn clone(&self) -> Record<Len, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Len: LenType, T: Debug> Debug for Record<Len, T>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a, Len: LenType> Decoder<'de> for Record<Len, &'a [u8]>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de: 'a, 'a, Len: LenType> Decoder<'de> for Record<Len, &'a str>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, K: Decoder<'de> + Ord, V: Decoder<'de>> Decoder<'de> for Record<Len, BTreeMap<K, V>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de> + Ord> Decoder<'de> for Record<Len, BTreeSet<T>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de> + Ord> Decoder<'de> for Record<Len, BinaryHeap<T>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, K: Decoder<'de> + Eq + Hash, V: Decoder<'de>, S: BuildHasher + Default> Decoder<'de> for Record<Len, HashMap<K, V, S>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de> + Eq + Hash, S: BuildHasher + Default> Decoder<'de> for Record<Len, HashSet<T, S>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de>> Decoder<'de> for Record<Len, LinkedList<T>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType> Decoder<'de> for Record<Len, String>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de>> Decoder<'de> for Record<Len, Vec<T>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<'de, Len: LenType, T: Decoder<'de>> Decoder<'de> for Record<Len, VecDeque<T>>

fn decoder(c: &mut &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, Box<dyn Error + Send + Sync>>

Example

impl<Len: Default + LenType, T: Default> Default for Record<Len, T>

fn default() -> Record<Len, T>

Returns the “default value” for a type.

impl<Len: LenType, T> Deref for Record<Len, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<Len: LenType, T> DerefMut for Record<Len, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<Len: LenType, T: Encoder> Encoder for Record<Len, &[T]>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType> Encoder for Record<Len, &str>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, K: Encoder, V: Encoder> Encoder for Record<Len, BTreeMap<K, V>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder> Encoder for Record<Len, BTreeSet<T>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder> Encoder for Record<Len, BinaryHeap<T>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, K: Encoder, V: Encoder, S> Encoder for Record<Len, HashMap<K, V, S>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder, S> Encoder for Record<Len, HashSet<T, S>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder> Encoder for Record<Len, LinkedList<T>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType> Encoder for Record<Len, String>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder> Encoder for Record<Len, Vec<T>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T: Encoder> Encoder for Record<Len, VecDeque<T>>

fn encoder(&self, c: &mut impl Write) -> Result<()>

Serialize the data into binary format.

fn encode(&self) -> Vec<u8>

Example

impl<Len: LenType, T> From<T> for Record<Len, T>

fn from(data: T) -> Self

Converts to this type from the input type.

impl<Len: LenType, T, V: FromIterator<T>> FromIterator<T> for Record<Len, V>

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<Len: Ord + LenType, T: Ord> Ord for Record<Len, T>

fn cmp(&self, other: &Record<Len, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<Len: PartialEq + LenType, T: PartialEq> PartialEq for Record<Len, T>

fn eq(&self, other: &Record<Len, T>) -> 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<Len: PartialOrd + LenType, T: PartialOrd> PartialOrd for Record<Len, T>

fn partial_cmp(&self, other: &Record<Len, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Len: Eq + LenType, T: Eq> Eq for Record<Len, T>

impl<Len: LenType, T> StructuralPartialEq for Record<Len, T>