Skip to main content

WireError

Enum WireError 

#[non_exhaustive]
pub enum WireError { UnsupportedFormatVersion { found: u16, supported: u16, }, }
Expand description

Why a wire-level decode was refused.

Separate from SyncError on purpose. That enum is ADR-0026’s and describes how a peer exchange failed; a version refusal is a decoding failure that happens before any exchange semantics apply. Folding this in later is a phase-13 decision about the message set, and it supersedes nothing to make it — whereas adding a variant to SyncError now would take that decision inside an encoding change.

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

UnsupportedFormatVersion

The sender speaks a format version this build does not implement.

The whole message is refused; nothing inside it has been decoded. A receiver may park the bytes and retry after an upgrade, which is the reason this must be distinguishable from a malformed message — those bytes will never decode, and parking them is a leak.

Fields

§found: u16

The version the sender stamped.

§supported: u16

The version this build implements, i.e. FORMAT_VERSION.

Implementations§

§

impl WireError

pub const UNSUPPORTED_FORMAT_VERSION: &'static str = "unsupported wire format version"

The stable text that marks a version refusal in a decoder’s error.

serde’s Deserialize has exactly one channel out — Error::custom, which takes a Display and erases the type — so a typed WireError cannot cross the boundary of Envelope’s Deserialize. What crosses is this text, and it is public precisely so that “refused, park this” stays distinguishable from “malformed, drop this” without callers matching on a message they had to copy out of the source.

§It crosses serde_json, and it does not cross postcard

Measured by wire::rejects_an_unknown_format_version, which pins both halves. postcard::Error is a fieldless enum, so its Error::custom discards the Display it is given and every refusal arrives as SerdeDeCustom — the text is dropped by the format, not by this module, and no wording here could survive it. A postcard receiver gets its typed answer the other way round: read the version off the front of the buffer with postcard::take_from_bytes::<u16> and hand it to check_format_version, which is the reason that function is public.

Trait Implementations§

§

impl Clone for WireError

§

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 Copy for WireError

§

impl Debug for WireError

§

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

Formats the value using the given formatter. Read more
§

impl Display for WireError

§

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

Formats the value using the given formatter. Read more
§

impl Eq for WireError

§

impl Error for WireError

1.30.0 · Source§

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 From<WireError> for CodecError

§

fn from(source: WireError) -> Self

Converts to this type from the input type.
§

impl Hash for WireError

§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
§

impl PartialEq for WireError

§

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 WireError

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.