Trait packed_struct::PackedStruct

pub trait PackedStruct where
    Self: Sized, {
    type ByteArray: ByteArray;
    fn pack(&self) -> PackingResult<Self::ByteArray>;
    fn unpack(src: &Self::ByteArray) -> PackingResult<Self>;
}

A structure that can be packed and unpacked from a byte array.

In case the structure occupies less bits than there are in the byte array, the packed that should be aligned to the end of the array, with leading bits being ignored.

10 bits packs into: [0b00000011, 0b11111111]

Associated Types

type ByteArray: ByteArray

The appropriately sized byte array into which this structure will be packed, for example [u8; 2].

Required methods

fn pack(&self) -> PackingResult<Self::ByteArray>

Packs the structure into a byte array.

fn unpack(src: &Self::ByteArray) -> PackingResult<Self>

Unpacks the structure from a byte array.

Implementations on Foreign Types

impl<const N: usize> PackedStruct for [u8; N]

type ByteArray = [u8; N]

fn pack(&self) -> PackingResult<Self::ByteArray>

fn unpack(src: &Self::ByteArray) -> Result<Self::ByteArray, PackingError>

impl PackedStruct for bool

type ByteArray = [u8; 1]

fn pack(&self) -> PackingResult<[u8; 1]>

fn unpack(src: &[u8; 1]) -> Result<bool, PackingError>

impl PackedStruct for u8

type ByteArray = [u8; 1]

fn pack(&self) -> PackingResult<[u8; 1]>

fn unpack(src: &[u8; 1]) -> Result<u8, PackingError>

impl PackedStruct for i8

type ByteArray = [u8; 1]

fn pack(&self) -> PackingResult<Self::ByteArray>

fn unpack(src: &Self::ByteArray) -> Result<i8, PackingError>

impl PackedStruct for ()

type ByteArray = [u8; 0]

fn pack(&self) -> PackingResult<[u8; 0]>

fn unpack(_src: &[u8; 0]) -> Result<(), PackingError>

Implementors

impl<T, B, I> PackedStruct for LsbInteger<T, B, I> where
    B: NumberOfBits,
    I: SizedInteger<T, B>, 

type ByteArray = <<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes

impl<T, B, I> PackedStruct for MsbInteger<T, B, I> where
    B: NumberOfBits,
    I: SizedInteger<T, B>, 

type ByteArray = <<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes

impl<V, B> PackedStruct for ReservedBits<V, B> where
    Self: Default,
    V: ReservedBitValue,
    B: NumberOfBits, 

type ByteArray = <<B as NumberOfBits>::Bytes as NumberOfBytes>::AsBytes