Skip to main content

ErrorKind

Enum ErrorKind 

Source
pub enum ErrorKind {
Show 17 variants ParseError, InvalidRequest, MethodNotFound, InvalidParams, Internal, UnsupportedVersion, CapabilityRequired, DeadlineExceeded, Cancelled, Unavailable, PermissionDenied, InteractionRequired, Conflict, OperationFailed, MessageTooLarge, RepresentationMismatch, Unrecognized,
}
Expand description

Stable machine-readable error kinds shared by both application protocols.

The set is closed for senders and open for receivers. An endpoint emits only the kinds below, but a receiver decodes anything it does not recognize as ErrorKind::Unrecognized instead of failing the frame. Without that, the first kind a later protocol version adds would kill every session with an older peer, and the set could never grow without a new protocol version.

Variants§

§

ParseError

§

InvalidRequest

§

MethodNotFound

§

InvalidParams

§

Internal

§

UnsupportedVersion

§

CapabilityRequired

§

DeadlineExceeded

§

Cancelled

§

Unavailable

§

PermissionDenied

§

InteractionRequired

§

Conflict

§

OperationFailed

§

MessageTooLarge

§

RepresentationMismatch

§

Unrecognized

A kind this implementation does not know, decoded from a peer that speaks a later revision of the protocol.

Receiving one means the operation failed for a reason this side cannot name, so it is handled as a failure and never as a success. An endpoint MUST NOT construct it: doing so would put "unrecognized" on the wire as if it were a defined kind.

Implementations§

Source§

impl ErrorKind

Source

pub const DEFINED: &'static [Self]

Every kind this revision defines, in wire-code order. Unrecognized is deliberately absent: it is a decoding outcome, not a defined kind.

Source

pub const fn as_str(self) -> &'static str

Stable wire spelling used for structured handling and redacted audit records.

Source

pub fn from_wire(kind: &str) -> Self

Decode a wire spelling, mapping anything unknown to Self::Unrecognized rather than refusing the frame.

Source

pub fn from_code(code: i32) -> Option<Self>

The kind a defined code names, or None for a code this revision does not define. Used to keep a peer honest: a code this side knows must arrive with the kind that belongs to it, and only a code it does not know may carry a kind it does not know.

Source

pub const fn code(self) -> i32

Source

pub const fn message(self) -> &'static str

Source

pub const fn retryable_by_default(self) -> bool

Trait Implementations§

Source§

impl Clone for ErrorKind

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 ErrorKind

Source§

impl Debug for ErrorKind

Source§

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

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

impl<'de> Deserialize<'de> for ErrorKind

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ErrorKind

Source§

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

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

impl Eq for ErrorKind

Source§

impl PartialEq for ErrorKind

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 Serialize for ErrorKind

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ErrorKind

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.