Struct bin_layout::Record

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

Record can be used to represent fixed-size integer to represent the length of a record.

It accepts fixed-length unsigned interger type of N (u8, u32, usize, etc..) and a generic type of T (Vec<T>, String etc..)

Example

use bin_layout::{Record, Encoder};

let record: Record<u8, &str> = "HelloWorld".into();
assert_eq!(record.len(), 10);

let bytes = record.encode();
assert_eq!(bytes.len(), 11);

Fields

data: T

Implementations

impl<N: FixedLenInt, T> Record<N, T>

pub fn new(data: T) -> Self

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: FixedLenInt, T: Debug> Debug for Record<N, T>

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

Formats the value using the given formatter.

impl<'de, E: Error, Len> Decoder<'de, E> for Record<Len, &'de [u8]> where
    usize: TryFrom<Len>,
    Len: FixedLenInt + Decoder<'de, E>, 

fn decoder(c: &mut Cursor<&'de [u8]>) -> Result<Self, E>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, E>

Example

impl<'de, E: Error, Len> Decoder<'de, E> for Record<Len, &'de str> where
    usize: TryFrom<Len>,
    Len: FixedLenInt + Decoder<'de, E>, 

fn decoder(c: &mut Cursor<&'de [u8]>) -> Result<Self, E>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, E>

Example

impl<'de, E: Error, Len> Decoder<'de, E> for Record<Len, String> where
    usize: TryFrom<Len>,
    Len: FixedLenInt + Decoder<'de, E>, 

fn decoder(c: &mut Cursor<&'de [u8]>) -> Result<Self, E>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, E>

Example

impl<'de, E: Error, Len, T> Decoder<'de, E> for Record<Len, Vec<T>> where
    T: Decoder<'de, E>,
    usize: TryFrom<Len>,
    Len: Decoder<'de, E> + FixedLenInt, 

fn decoder(c: &mut Cursor<&'de [u8]>) -> Result<Self, E>

Deserialize the data from binary format.

fn decode(data: &'de [u8]) -> Result<Self, E>

Example

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

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

Returns the “default value” for a type.

impl<N: FixedLenInt, T> Deref for Record<N, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<N: FixedLenInt, T> DerefMut for Record<N, T>

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

Mutably dereferences the value.

impl<Len: Encoder + FixedLenInt> Encoder for Record<Len, &[u8]>

fn size_hint(&self) -> usize

Calculate total estimated size of the data structure in bytes.

fn encoder(self, c: &mut Cursor<impl Bytes>)

Serialize the data to binary format.

const SIZE: usize

The size of the data type in bytes. (padding not included)

fn encode(self) -> Vec<u8>

Example

impl<Len: Encoder + FixedLenInt> Encoder for Record<Len, &str>

fn size_hint(&self) -> usize

Calculate total estimated size of the data structure in bytes.

fn encoder(self, c: &mut Cursor<impl Bytes>)

Serialize the data to binary format.

const SIZE: usize

The size of the data type in bytes. (padding not included)

fn encode(self) -> Vec<u8>

Example

impl<Len: Encoder + FixedLenInt> Encoder for Record<Len, String>

fn size_hint(&self) -> usize

Calculate total estimated size of the data structure in bytes.

fn encoder(self, c: &mut Cursor<impl Bytes>)

Serialize the data to binary format.

const SIZE: usize

The size of the data type in bytes. (padding not included)

fn encode(self) -> Vec<u8>

Example

impl<Len, T> Encoder for Record<Len, Vec<T>> where
    T: Encoder,
    Len: Encoder + FixedLenInt, 

fn size_hint(&self) -> usize

Calculate total estimated size of the data structure in bytes.

fn encoder(self, c: &mut Cursor<impl Bytes>)

Serialize the data to binary format.

const SIZE: usize

The size of the data type in bytes. (padding not included)

fn encode(self) -> Vec<u8>

Example

impl<N: FixedLenInt, T> From<T> for Record<N, T>

fn from(data: T) -> Self

Converts to this type from the input type.

impl<Len: Ord + FixedLenInt, 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

fn eq(&self, other: &Record<Len, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Record<Len, T>) -> bool

This method tests for !=.

impl<Len: PartialOrd + FixedLenInt, T: PartialOrd> PartialOrd<Record<Len, T>> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

impl<Len: FixedLenInt, T> StructuralEq for Record<Len, T>

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