Skip to main content

CodecError

Enum CodecError 

#[non_exhaustive]
pub enum CodecError { UnsupportedVersion(WireError),
#[non_exhaustive]
Malformed { route: Route, cause: PostcardError, },
#[non_exhaustive]
TrailingBytes { route: Route, extra: usize, },
#[non_exhaustive]
Unencodable { route: Route, cause: PostcardError, }, }
Expand description

Why envelope bytes could not be read or written.

Every arm is Stop. The same bytes fail the same way on every retry, and the remedy — an upgrade on one side, or a fix to the transport that mangled the buffer — is an operator’s.

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

UnsupportedVersion(WireError)

The sender stamped a format version this build does not speak, and nothing past the version was decoded.

§

#[non_exhaustive]
Malformed

The bytes are not a postcard envelope holding the message route carries. A mis-routed buffer can land here, or can decode silently as the wrong message (ADR-0097 §1): routing is the transport’s to get right.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§route: Route

The route the bytes travelled on.

§cause: PostcardError

What the decoder said.

§

#[non_exhaustive]
TrailingBytes

A whole envelope decoded and bytes were left over. Refused rather than ignored: a buffer that carries more than one message is a transport that framed it wrong, and whatever the extra bytes were is lost.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§route: Route

The route the bytes travelled on.

§extra: usize

How many bytes followed the envelope.

§

#[non_exhaustive]
Unencodable

A message could not be encoded.

Fields

This variant is marked as non-exhaustive
Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.
§route: Route

The route the message was for.

§cause: PostcardError

What the encoder said.

Trait Implementations§

§

impl Classify for CodecError

§

fn class(&self) -> FailureClass

The remedy this failure calls for.
§

impl Clone for CodecError

§

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
§

impl Debug for CodecError

§

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

Formats the value using the given formatter. Read more
§

impl Display for CodecError

§

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

Formats the value using the given formatter. Read more
§

impl Eq for CodecError

§

impl Error for CodecError

§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
§

impl<E> From<CodecError> for RemoteError<E>

§

fn from(source: CodecError) -> Self

Converts to this type from the input type.
§

impl<R, W, A> From<CodecError> for ServeError<R, W, A>

§

fn from(source: CodecError) -> Self

Converts to this type from the input type.
§

impl From<WireError> for CodecError

§

fn from(source: WireError) -> Self

Converts to this type from the input type.
§

impl PartialEq for CodecError

§

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
§

impl StructuralPartialEq for CodecError

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.