Skip to main content

ErrorCode

Enum ErrorCode 

Source
#[non_exhaustive]
pub enum ErrorCode {
Show 14 variants Transport, Handshake, Timeout, ConnectionLost, LiteServer, Decode, Address, Config, Cell, Proof, Sync, Stale, ClockBehind, InvalidArgument,
}
Expand description

The stable name for a kind of failure, for a caller that has to branch on one.

Error is #[non_exhaustive], so outside this crate it cannot be matched to the end, and a caller who tried would be writing a wildcard arm that silently swallows whatever is added next. This is the type to match on instead: the variant set is what callers are promised, and as_str is the same name spelled for a language that has no enums.

§Why it lives here and not in each binding

Which failure occurred decides what a caller does next, and two of the answers are opposites. A transport failure means the socket dropped and the server may be fine, so trying again is right. A proof failure means the server did not prove its answer, so asking it again is the reverse of what this library is for.

That distinction has to reach every language this library is bound into, spelled the same way. Held in a binding it is one match per binding, drifting as each is written, and a caller who learns PROOF in JavaScript meets something else in Swift. Held here, a binding maps rather than invents.

The strings are a compatibility surface: they are what a caller compares against, so they are fixed once published, and renaming one breaks a caller no compiler warns.

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

Transport

A socket could not connect, read, or write. The server may be fine.

§

Handshake

The ADNL handshake failed: the configured key is not the key that answered.

§

Timeout

A call passed its deadline.

§

ConnectionLost

The connection lost its place in the cipher stream and cannot be reused.

§

LiteServer

The liteserver answered with an error of its own.

§

Decode

Bytes that did not read, from a call that verified nothing.

§

Address

An address that is not one.

§

Config

A network configuration that could not be used.

§

Cell

A cell or bag of cells that is not well formed.

§

Proof

A server did not prove its answer. Asking it again is not the repair.

§

Sync

A walk toward the head could not be completed or checked.

§

Stale

The proven head is older than the caller allowed.

§

ClockBehind

The local clock is far enough behind the chain that freshness cannot be judged.

§

InvalidArgument

An argument refused before any call was made.

No Error carries this: the failure is the caller’s rather than the network’s, and it happens above this crate. It is named here anyway, because a binding that validates its own arguments needs a spelling for it, and the point of this type is that the spelling is not invented once per language.

Implementations§

Source§

impl ErrorCode

Source

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

The stable name, for a binding whose language has no enums.

Upper case with underscores, the form the Node binding already publishes in its message prefix.

Trait Implementations§

Source§

impl Clone for ErrorCode

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 ErrorCode

Source§

impl Debug for ErrorCode

Source§

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

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

impl Display for ErrorCode

Source§

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

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

impl Eq for ErrorCode

Source§

impl Hash for ErrorCode

Source§

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

impl PartialEq for ErrorCode

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 ErrorCode

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> Same for T

Source§

type Output = T

Should always be Self
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.