Struct Packer 

pub struct Packer<'a> { /* private fields */ }

Packer of POD values into a StructBuf.

The packer maintains an index (0 <= i <= lim()) where new values are written, which is incremented after each write. Write operations panic if the buffer capacity limit is exceeded.

The packer intentionally does not expose the underlying StructBuf to guarantee append-only operation.

Little-endian encoding is assumed.

Implementations

impl Packer<'_>

pub const fn position(&self) -> usize

Returns the current index.

pub fn remaining(&self) -> usize

Returns the number of additional bytes that can be written.

pub fn skip(&mut self, n: usize) -> &mut Self

Advances the current index by n bytes.

pub fn bool<T: Into<bool>>(&mut self, v: T) -> &mut Self

Writes a bool as a u8 at the current index.

pub fn u8<T: Into<u8>>(&mut self, v: T) -> &mut Self

Writes a u8 at the current index.

pub fn u16<T: Into<u16>>(&mut self, v: T) -> &mut Self

Writes a u16 at the current index.

pub fn u24<T: Into<u32>>(&mut self, v: T) -> &mut Self

Writes a u32 as a u24 at the current index.

Panics

Panics if v cannot be represented in 24 bits.

pub fn u32<T: Into<u32>>(&mut self, v: T) -> &mut Self

Writes a u32 at the current index.

pub fn u64<T: Into<u64>>(&mut self, v: T) -> &mut Self

Writes a u64 at the current index.

pub fn u128<T: Into<u128>>(&mut self, v: T) -> &mut Self

Writes a u128 at the current index.

pub fn i8<T: Into<i8>>(&mut self, v: T) -> &mut Self

Writes an i8 at the current index.

pub fn i16<T: Into<i16>>(&mut self, v: T) -> &mut Self

Writes an i16 at the current index.

pub fn i32<T: Into<i32>>(&mut self, v: T) -> &mut Self

Writes an i32 at the current index.

pub fn i64<T: Into<i64>>(&mut self, v: T) -> &mut Self

Writes an i64 at the current index.

pub fn i128<T: Into<i128>>(&mut self, v: T) -> &mut Self

Writes an i128 at the current index.

pub const fn can_put(&self, n: usize) -> bool

Returns whether n bytes can be written at the current index.

pub fn put<T: AsRef<[u8]>>(&mut self, v: T) -> &mut Self

Writes v at the current index.

Trait Implementations

impl AsMut<[u8]> for Packer<'_>

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Packer<'_>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for Packer<'a>

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

Formats the value using the given formatter.

impl From<&mut Packer<'_>> for ()

Allows terminating packer method calls with .into().

fn from(_: &mut Packer<'_>) -> Self

Converts to this type from the input type.