Skip to main content

ReadError

Enum ReadError 

Source
#[non_exhaustive]
pub enum ReadError { Short { needed: usize, }, ShortClaim { claim: ClaimId, needed: usize, trace: Option<TraceContext>, }, TooFewSamples { needed: usize, }, Contract(Contract), Detached, }
Expand description

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)§

This enum is marked as 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.

§

ShortClaim

The output buffer is too short for the next claim’s arguments (Handler::next_claim alone). Nothing was consumed: the claim stays the next one, and a later next_claim with a buffer of at least needed bytes presents it under the same claim. The id is reported so that a provider can settle the claim without reading its arguments; the generated serve settles it CallError::Transport(Transport::Corrupt), because an argument that does not fit the serving interface’s MAX_BUFFER_SIZE — its largest argument or reply payload, larger than any valid encoding of its members — is not a well-formed encoding of one; a claim naming another interface may be validly larger, and is settled the same, because the serving step cannot read it (ADR-0021 decision 5, amended 2026-09-28).

Fields

§claim: ClaimId

The claim whose arguments did not fit.

§needed: usize

The bytes the read needs.

§trace: Option<TraceContext>

The trace context the sender passed to command or query, or None, under the delivery rules on Handler that apply to Claim::trace. A provider that settles the claim without reading it has the context here.

§

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§

Source§

impl Clone for ReadError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ReadError

Source§

impl Debug for ReadError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ReadError

Source§

impl From<ReadError> for ClientError

Source§

fn from(error: ReadError) -> Self

Converts to this type from the input type.
Source§

impl From<ReadError> for ProviderError

Source§

fn from(error: ReadError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for ReadError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ReadError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.