Struct bin_layout::Record

source · [−]

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

Expand description

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, DataType};

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

let mut writer = [0; 16].into();
record.serialize(&mut writer);

// One byte for length `u8` and 10 bytes for string. (Total 11 bytes written)
assert_eq!(writer.offset, 11);

Fields

data: T

Implementations

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

pub fn new(data: T) -> Self

Trait Implementations

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

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<'de, N> DataType<'de> for Record<N, &'de [u8 ]> where
N: DataType<'de> + FixedLenInt,
usize: TryFrom<N>,

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

Serialize the data to binary format.

fn deserialize(view: &mut Cursor<&'de [u8 ]>) -> Result<Self>

Deserialize the data from binary format.

fn encode(self, data: &mut [u8 ]) -> Result<()>

Shortcut for DataType::serialize(self, &mut View::new(bytes.as_mut())) Read more

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

Shortcut for DataType::deserialize(&mut View::new(bytes.as_ref())) Read more

impl<'de, N> DataType<'de> for Record<N, String> where
N: DataType<'de> + FixedLenInt,
usize: TryFrom<N>,

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

Serialize the data to binary format.

fn deserialize(view: &mut Cursor<&'de [u8 ]>) -> Result<Self>

Deserialize the data from binary format.

fn encode(self, data: &mut [u8 ]) -> Result<()>

Shortcut for DataType::serialize(self, &mut View::new(bytes.as_mut())) Read more

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

Shortcut for DataType::deserialize(&mut View::new(bytes.as_ref())) Read more

impl<'de, N> DataType<'de> for Record<N, &'de str> where
N: DataType<'de> + FixedLenInt,
usize: TryFrom<N>,

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

Serialize the data to binary format.

fn deserialize(view: &mut Cursor<&'de [u8 ]>) -> Result<Self>

Deserialize the data from binary format.

fn encode(self, data: &mut [u8 ]) -> Result<()>

Shortcut for DataType::serialize(self, &mut View::new(bytes.as_mut())) Read more

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

Shortcut for DataType::deserialize(&mut View::new(bytes.as_ref())) Read more

impl<'de, N, T> DataType<'de> for Record<N, Vec<T>> where
    T: DataType<'de>,
    N: DataType<'de> + FixedLenInt,
    usize: TryFrom<N>,

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

Serialize the data to binary format.

fn deserialize(view: &mut Cursor<&'de [u8 ]>) -> Result<Self>

Deserialize the data from binary format.

fn encode(self, data: &mut [u8 ]) -> Result<()>

Shortcut for DataType::serialize(self, &mut View::new(bytes.as_mut())) Read more

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

Shortcut for DataType::deserialize(&mut View::new(bytes.as_ref())) Read more

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

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

Formats the value using the given formatter. Read more

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

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

Returns the “default value” for a type. Read more

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<N: FixedLenInt, T> From<T> for Record<N, T>

fn from(data: T) -> Self

Performs the conversion.

impl<N: Ord + FixedLenInt, T: Ord> Ord for Record<N, T>

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

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

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

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

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

This method tests for !=.

impl<N: PartialOrd + FixedLenInt, T: PartialOrd> PartialOrd<Record<N, T>> for Record<N, T>

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

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

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

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

Auto Trait Implementations

impl<N, T> RefUnwindSafe for Record<N, T> where
N: RefUnwindSafe,
T: RefUnwindSafe,

impl<N, T> Send for Record<N, T> where
N: Send,
T: Send,

impl<N, T> Sync for Record<N, T> where
N: Sync,
T: Sync,

impl<N, T> Unpin for Record<N, T> where
N: Unpin,
T: Unpin,

impl<N, T> UnwindSafe for Record<N, T> where
N: UnwindSafe,
T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<!> for T

const: unstable · source

fn from(t: !) -> T

Performs the conversion.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.