Struct protocol::types::Unimplemented

pub struct Unimplemented;

A type that does not have any protocol serialization implemented.

Behaviour

If any unimplemented parcel is read, an error of type UnimplementedParcel is returned. This allows clients to handle unimplemented data gracefully.

If you attempt to write an unimplemented parcel, the program panics. It makes sense to do error handling on unimplemented types that are read from remote machines, but it does not make sense to allow undefined data to be sent.

Trait Implementations

impl Parcel for Unimplemented

const TYPE_NAME: &'static str

The textual name of the type.

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

Reads a value from a stream.

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

Writes a value to a stream.

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

Reads a new item with a fresh set of hints.

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

Writes a value to a stream.

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

Convers the value into a byte stream that implements std::io::Read.

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

Parses a new value from its raw byte representation.

fn field_from_raw_bytes(
    bytes: &[u8],
    settings: &Settings,
    hints: &mut Hints
) -> Result<Self, Error>

Parses a new value from its raw byte representation.

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

Gets the raw byte representation of the value.

fn raw_bytes_field(
    &self,
    settings: &Settings,
    hints: &mut Hints
) -> Result<Vec<u8>, Error>

Gets the raw bytes of this type as a field of a larger type.

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

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

impl Clone for Unimplemented

fn clone(&self) -> Unimplemented

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Unimplemented

impl Eq for Unimplemented

impl Ord for Unimplemented

fn cmp(&self, other: &Unimplemented) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Unimplemented> for Unimplemented

fn eq(&self, other: &Unimplemented) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Unimplemented> for Unimplemented

fn partial_cmp(&self, other: &Unimplemented) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Unimplemented

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

Formats the value using the given formatter.

impl Hash for Unimplemented

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].