Trait protocol::Parcel

pub trait Parcel: Sized {
    const TYPE_NAME: &'static str;

    fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>;
    fn write(
        &self,
        write: &mut dyn Write,
        settings: &Settings
    ) -> Result<(), Error>;

    fn from_raw_bytes(bytes: &[u8], settings: &Settings) -> Result<Self, Error> { ... }
    fn raw_bytes(&self, settings: &Settings) -> Result<Vec<u8>, Error> { ... }
    fn type_name(&self) -> &'static str { ... }
}

A value which can be read and written.

All of the expected standard Rust types implement this.

Types that implement Parcel include (not exhaustive):

• The Rust primitive types
  • u8, i8, u16, i16 … u64
  • bool, char
  • f32, f64
  • Tuples
    • (T1) where T1: Parcel
    • (T1, T2) where T1: Parcel, T2: Parcel
    • (T1, T2, ... Tn) where T1: Parcel, T2: Parcel, ... Tn: Parcel
  • Arrays
    • [T; 0] where T: Parcel
    • [T; 1] where T: Parcel
    • [T; 2] where T: Parcel
    • [T; 32] where T: Parcel
    • [T; 40] where T: Parcel
    • [T; 42] where T: Parcel
    • …
    • [T; 64] where T: Parcel
    • …
    • [T; 1024] where T: Parcel
  • String
  • Option<T: Parcel>
  • Box<T: Parcel>
  • Smart pointers
    • std::rc::Rc
    • std::sync::Arc
  • std::collections
    • Vec<T: Parcel>
    • VecDeque<T: Parcel>
    • HashMap<T: Parcel>
    • BTreeMap<T: Parcel>

Required Associated Constants

const TYPE_NAME: &'static str

The textual name of the type.

Required Methods

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

Reads a value from a stream.

Blocks until a value is received.

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

Writes a value to a stream.

Provided Methods

fn from_raw_bytes(bytes: &[u8], settings: &Settings) -> Result<Self, Error>

Parses a new value from its raw byte representation.

Returns Err if the bytes represent an invalid value.

fn raw_bytes(&self, settings: &Settings) -> Result<Vec<u8>, Error>

Gets the raw byte representation of the value.

fn type_name(&self) -> &'static str

Gets the name of the type; Parcel::TYPE_NAME.

Implementations on Foreign Types

impl<T: Parcel> Parcel for [T; 1]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 2]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 3]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 4]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 5]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 6]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 7]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 8]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 9]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 10]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 11]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 12]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 13]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 14]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 15]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 16]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 17]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 18]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 19]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 20]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 21]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 22]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 23]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 24]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 25]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 26]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 27]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 28]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 29]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 30]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 31]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 32]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 40]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 42]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 48]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 64]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 80]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 120]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 128]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 256]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 500]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 512]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 1000]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 1024]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 4096]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for [T; 65535]where
    T: Copy,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for char

const TYPE_NAME: &'static str = "char"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T> Parcel for LinkedList<T>where
    T: Parcel,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T> Parcel for VecDeque<T>where
    T: Parcel,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T> Parcel for BTreeSet<T>where
    T: Parcel + Ord,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T> Parcel for HashSet<T>where
    T: Parcel + Hash + Eq,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<K, V> Parcel for HashMap<K, V>where
    K: Parcel + Hash + Eq,
    V: Parcel,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<K, V> Parcel for BTreeMap<K, V>where
    K: Parcel + Ord,
    V: Parcel,

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T> Parcel for PhantomData<T>

const TYPE_NAME: &'static str = "PhantomData<T>"

fn read(_: &mut dyn Read, _: &Settings) -> Result<Self, Error>

fn write(&self, _: &mut dyn Write, _: &Settings) -> Result<(), Error>

impl Parcel for bool

const TYPE_NAME: &'static str = "bool"

fn read(read: &mut dyn Read, _: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, _: &Settings) -> Result<(), Error>

impl Parcel for u8

const TYPE_NAME: &'static str = "u8"

fn read(read: &mut dyn Read, _: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, _: &Settings) -> Result<(), Error>

impl Parcel for i8

const TYPE_NAME: &'static str = "i8"

fn read(read: &mut dyn Read, _: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, _: &Settings) -> Result<(), Error>

impl Parcel for u16

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for i16

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for u32

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for i32

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for u64

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for i64

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for f32

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for f64

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for Option<T>

const TYPE_NAME: &'static str = "Option<T>"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl Parcel for String

const TYPE_NAME: &'static str = "String"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T0, T1> Parcel for (T0, T1)where
    T0: Parcel,
    T1: Parcel,

const TYPE_NAME: &'static str = "(T0, T1)"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T0, T1, T2> Parcel for (T0, T1, T2)where
    T0: Parcel,
    T1: Parcel,
    T2: Parcel,

const TYPE_NAME: &'static str = "(T0, T1, T2)"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T0, T1, T2, T3> Parcel for (T0, T1, T2, T3)where
    T0: Parcel,
    T1: Parcel,
    T2: Parcel,
    T3: Parcel,

const TYPE_NAME: &'static str = "(T0, T1, T2, T3)"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T0, T1, T2, T3, T4> Parcel for (T0, T1, T2, T3, T4)where
    T0: Parcel,
    T1: Parcel,
    T2: Parcel,
    T3: Parcel,
    T4: Parcel,

const TYPE_NAME: &'static str = "(T0, T1, T2, T3, T4)"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for Rc<T>

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for Arc<T>

const TYPE_NAME: &'static str = _

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

impl<T: Parcel> Parcel for Vec<T>

const TYPE_NAME: &'static str = "Vec<T>"

fn read(read: &mut dyn Read, settings: &Settings) -> Result<Self, Error>

fn write(&self, write: &mut dyn Write, settings: &Settings) -> Result<(), Error>

Implementors

impl Parcel for Unimplemented

const TYPE_NAME: &'static str = "Unimplemented"

impl<S: Integer> Parcel for protocol::types::String<S>

const TYPE_NAME: &'static str = "protocol::String<S>"

impl<S: Integer, T: Parcel> Parcel for protocol::types::Vec<S, T>

const TYPE_NAME: &'static str = "protocol::Vec<S,T>"