Trait byte_struct::ByteStructImpl

pub trait ByteStructImpl {
    const BYTE_LEN: usize;

    fn write_le_bytes(&self, bytes: &mut [u8]);
    fn read_le_bytes(bytes: &[u8]) -> Self;
    fn write_be_bytes(&self, bytes: &mut [u8]);
    fn read_be_bytes(bytes: &[u8]) -> Self;
}

A type that can be packed into or unpacked from raw bytes under given default byte order.

This trait is implemented for most numeric primitive types, except for bool, char, isize and usize. This is also implemented for array types whose element type implements ByteStructImpl and whose size is between 1 and 32 (inclusive).

This trait is also implemented for struct with either #[derive(ByteStructLE)] or #[derive(ByteStructBE)].

Members in this trait, except for BYTE_LEN, are meant to be used by byte_struct internal only. They do not do what one might expect: the byte orders specified in read_*_bytes/write_*_bytes functions are only default byte order. The default byte order is only repected when the type itself does not carry byte order specification (e.g. primitive types). In contrast, since ByteStruct-derived structures always have byte order specification, the default byte order has no effect on them, and the three versions of read / write functions, _le_, _be_ and no-spec from ByteStruct, behave exactly the same.

In some cases, one might want to implement ByteStructImpl for custom types so that they can be members of ByteStruct-derived structures.

Associated Constants

const BYTE_LEN: usize

The length of the byte representation of this type

Loading content...

Required methods

fn write_le_bytes(&self, bytes: &mut [u8])

Packs the object into raw bytes with little-endian as the default byte order

fn read_le_bytes(bytes: &[u8]) -> Self

Unpacks raw bytes into a new object with little-endian as the default byte order

fn write_be_bytes(&self, bytes: &mut [u8])

Packs the object into raw bytes with big-endian as the default byte order

fn read_be_bytes(bytes: &[u8]) -> Self

Unpacks raw bytes into a new object with big-endian as the default byte order

Loading content...

Implementations on Foreign Types

impl ByteStructImpl for u8

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for i8

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for u16

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for i16

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for u32

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for i32

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for u64

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for i64

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for u128

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for i128

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for f32

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl ByteStructImpl for f64

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 1]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 2]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 3]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 4]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 5]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 6]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 7]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 8]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 9]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 10]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 11]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 12]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 13]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 14]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 15]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 16]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 17]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 18]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 19]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 20]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 21]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 22]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 23]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 24]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 25]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 26]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 27]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 28]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 29]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 30]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 31]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 32]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 100]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

impl<T: ByteStructImpl> ByteStructImpl for [T; 3000]

const BYTE_LEN: usize

fn write_le_bytes(&self, bytes: &mut [u8])

fn read_le_bytes(bytes: &[u8]) -> Self

fn write_be_bytes(&self, bytes: &mut [u8])

fn read_be_bytes(bytes: &[u8]) -> Self

Loading content...

Implementors

Loading content...