Struct bin_layout::Record

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

This utility struct use for serialize or deserialize variable length records.

By default, String or Vec<T> are encoded with their length value first, Size of size is u32

But this utility struct allow you to encode different length size, for example: u8, u16, usize etc…

Example

use bin_layout::{DataType, Record};
 
let record: Record<u8, String> = String::from("HelloWorld").into();
assert_eq!(record.len(), 10);
 
let mut buf = [0; 16].into();
DataType::serialize(record, &mut buf);
 
// One byte for length, 10 bytes for string
assert_eq!(buf.offset, 11);  // 11 bytes written to buffer

Fields

data: Type

Trait Implementations

impl<Len: Clone, Type: Clone> Clone for Record<Len, Type>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> DataType for Record<E, String> where
    E: Endian + TryFrom<usize>,
    E::Error: Debug,
    usize: TryFrom<E>, 

fn serialize(self, view: &mut DataView<impl AsMut<[u8]>>)

fn deserialize(view: &mut DataView<impl AsRef<[u8]>>) -> Result<Self>

impl<E, D> DataType for Record<E, Vec<D>> where
    D: DataType,
    E: Endian + TryFrom<usize>,
    E::Error: Debug,
    usize: TryFrom<E>, 

fn serialize(self, view: &mut DataView<impl AsMut<[u8]>>)

fn deserialize(view: &mut DataView<impl AsRef<[u8]>>) -> Result<Self>

impl<L, T: Debug> Debug for Record<L, T>

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

Formats the value using the given formatter.

impl<Len: Default, Type: Default> Default for Record<Len, Type>

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

Returns the “default value” for a type.

impl<L, T> Deref for Record<L, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<L, T> DerefMut for Record<L, T>

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

Mutably dereferences the value.

impl<L, T> From<T> for Record<L, T>

fn from(data: T) -> Self

Performs the conversion.

impl<Len: Ord, Type: Ord> Ord for Record<Len, Type>

fn cmp(&self, other: &Record<Len, Type>) -> 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, Type: PartialEq> PartialEq<Record<Len, Type>> for Record<Len, Type>

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

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

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

This method tests for !=.

impl<Len: PartialOrd, Type: PartialOrd> PartialOrd<Record<Len, Type>> for Record<Len, Type>

fn partial_cmp(&self, other: &Record<Len, Type>) -> 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, Type: Eq> Eq for Record<Len, Type>

impl<Len, Type> StructuralEq for Record<Len, Type>

impl<Len, Type> StructuralPartialEq for Record<Len, Type>