Trait packtool::Packed

pub trait Packed: Sized {
    const SIZE: usize;

    fn unchecked_read_from_slice(slice: &[u8]) -> Self;
    fn unchecked_write_to_slice(&self, _slice: &mut [u8]);
    fn check(slice: &[u8]) -> Result<(), Error>;

    fn read(view: View<'_, Self>) -> Self { ... }
}

trait to define how a fixed size Packed object is serialized into a byte slice representation.

see crate documentation for more information.

Associated Constants

const SIZE: usize

the static size of a packed object in a byte array

this is not necessarily the ::std::mem::size_of::<Self>() but the size it takes to have this object on a slice of memory.

Required methods

fn unchecked_read_from_slice(slice: &[u8]) -> Self

assuming the given slice if valid, perform a conversion from the slice to the object.

fn unchecked_write_to_slice(&self, _slice: &mut [u8])

assuming there is enough slice available in the

fn check(slice: &[u8]) -> Result<(), Error>

check the validity of the given slice to hold the appropriate value

the length of the slice is already handled by the View::try_from_slice method so no need to do that again in here.

Provided methods

fn read(view: View<'_, Self>) -> Self

assuming the given slice if valid, perform a conversion from the slice to the object.

it should be assumed the checks have been performed appropriately since we are passing in the View and not the raw slice.

Implementations on Foreign Types

impl<const SIZE: usize> Packed for [u8; SIZE]

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_read_from_slice(slice: &[u8]) -> Self

fn unchecked_write_to_slice(&self, slice: &mut [u8])

impl Packed for i8

const SIZE: usize

fn unchecked_read_from_slice(slice: &[u8]) -> Self

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn check(_slice: &[u8]) -> Result<(), Error>

impl Packed for u8

const SIZE: usize

fn unchecked_read_from_slice(slice: &[u8]) -> Self

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn check(_slice: &[u8]) -> Result<(), Error>

impl Packed for u16

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for u32

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for u64

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for u128

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for usize

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for i16

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for i32

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for i64

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for i128

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl Packed for isize

const SIZE: usize

fn check(_slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed> Packed for (A,)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed> Packed for (A, B)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed> Packed for (A, B, C)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed> Packed for (A, B, C, D)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed> Packed for (A, B, C, D, E)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed> Packed for (A, B, C, D, E, F)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed> Packed for (A, B, C, D, E, F, G)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed, H: Packed> Packed for (A, B, C, D, E, F, G, H)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed, H: Packed, I: Packed> Packed for (A, B, C, D, E, F, G, H, I)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed, H: Packed, I: Packed, J: Packed> Packed for (A, B, C, D, E, F, G, H, I, J)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed, H: Packed, I: Packed, J: Packed, K: Packed> Packed for (A, B, C, D, E, F, G, H, I, J, K)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

impl<A: Packed, B: Packed, C: Packed, D: Packed, E: Packed, F: Packed, G: Packed, H: Packed, I: Packed, J: Packed, K: Packed, L: Packed> Packed for (A, B, C, D, E, F, G, H, I, J, K, L)

const SIZE: usize

fn check(slice: &[u8]) -> Result<(), Error>

fn unchecked_write_to_slice(&self, slice: &mut [u8])

fn unchecked_read_from_slice(slice: &[u8]) -> Self

Implementors