#[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
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.