Trait bee_common::packable::Packable

pub trait Packable {
    type Error: Debug;
    fn packed_len(&self) -> usize;
    fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>;
    fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
        reader: &mut R
    ) -> Result<Self, Self::Error>
    where
        Self: Sized;

    fn pack_new(&self) -> Vec<u8> { ... }
    fn unpack<R: Read + ?Sized>(reader: &mut R) -> Result<Self, Self::Error>
    where
        Self: Sized,
    { ... }
    fn unpack_unchecked<R: Read + ?Sized>(
        reader: &mut R
    ) -> Result<Self, Self::Error>
    where
        Self: Sized,
    { ... }
}

A trait to pack and unpack types to and from bytes.

Associated Types

type Error: Debug

Associated error type.

Loading content...

Required methods

fn packed_len(&self) -> usize

Returns the length of the packed bytes.

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

Packs the instance to bytes and writes them to the passed writer.

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

Reads bytes from the passed reader and unpacks them into an instance.

Loading content...

Provided methods

fn pack_new(&self) -> Vec<u8>

Packs the instance to bytes and writes them to a newly allocated vector.

fn unpack<R: Read + ?Sized>(reader: &mut R) -> Result<Self, Self::Error> where
    Self: Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Applies syntactic checks.

fn unpack_unchecked<R: Read + ?Sized>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

Reads bytes from the passed reader and unpacks them into an instance. Doesn’t apply syntactic checks.

Loading content...

Implementations on Foreign Types

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

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for bool

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl<P> Packable for Vec<P> where
    P: Packable,
    P::Error: From<Error>, 

type Error = P::Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl<P: Packable> Packable for Option<P>

type Error = OptionError<P::Error>

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for i8

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for u8

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for i16

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for u16

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for i32

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for u32

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for i64

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for u64

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for i128

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

impl Packable for u128

type Error = Error

fn packed_len(&self) -> usize

fn pack<W: Write>(&self, writer: &mut W) -> Result<(), Self::Error>

fn unpack_inner<R: Read + ?Sized, const CHECK: bool>(
    reader: &mut R
) -> Result<Self, Self::Error> where
    Self: Sized, 

Loading content...

Implementors

Loading content...