Enum ReadError 

#[non_exhaustive]
pub enum ReadError {
    Short {
        needed: usize,
    },
    TooFewSamples {
        needed: usize,
    },
    Contract(Contract),
    Detached,
}

A read that failed.

One enum serves every read on every port, so a variant can be unreachable for the method that returns it: TooFewSamples belongs to CoherentSignals::read_coherent alone, and Caller::reply never returns Contract. Each method documents what it can return.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Short

The output buffer is too short. Nothing was consumed.

Fields

needed: usize

The bytes the read needs.

TooFewSamples

samples has fewer entries than ords. Nothing was consumed.

Fields

needed: usize

The entries samples needs.

Contract(Contract)

A contract error, such as an unknown interaction.

Detached

The runtime behind the port is gone.

Trait Implementations

impl Clone for ReadError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReadError

impl Debug for ReadError

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

Formats the value using the given formatter.

impl Eq for ReadError

impl From<ReadError> for ClientError

fn from(error: ReadError) -> Self

Converts to this type from the input type.

impl From<ReadError> for ProviderError

fn from(error: ReadError) -> Self

Converts to this type from the input type.

impl PartialEq for ReadError

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReadError