Enum Error 

#[non_exhaustive]
#[repr(u32)]
pub enum Error {
    RemoteRpcError(String),
    UnknownRpcError = 101,
    InternalRpcError(Error),
    UuidError(Error),
    ConnectionNotFound = 203,
    NewConnectionError(Error),
    CloseConnectionError(Error),
    InvalidConnectionId = 206,
    CreateOffer(Error),
    AnswerOffer(Error),
    AcceptAnswer(Error),
    DecodeError = 300,
    EncodeError = 301,
    WasmCompileError(String),
    WasmBackendMessageRwLockError = 401,
    WasmInstantiationError = 402,
    WasmExportError = 403,
    WasmRuntimeError(String),
    WasmGlobalMemoryLockError = 405,
    WasmFailedToLoadFile = 406,
    InvalidDid(String),
    InvalidMethod = 501,
    InternalError(Error),
    NoPermission = 504,
    ConnectError(Error),
    SendMessage(Error),
    EntryError(Error),
    ServiceRegisterError(Error),
    JsError(String),
    InvalidMessage = 800,
    HttpRequestError(String),
    InvalidData = 802,
    InvalidService = 803,
    InvalidAddress = 804,
    InvalidAuthData = 805,
    InvalidHeaders = 806,
    Storage(Error),
    Swarm(Error),
    InvalidLoggingLevel(String),
    InvalidWebrtcUdpPortRange(WebrtcUdpPortRangeError),
    IncompleteWebrtcUdpPortRange {
        min: Option<u16>,
        max: Option<u16>,
    },
    InvalidConfig(String),
    BrowserStorageOpen {
        name: String,
        source: Error,
    },
    RegistrationStopped = 815,
    MeasurementRuntime(MeasureRuntimeError),
    CreateFileError(String),
    OpenFileError(String),
    Lock = 902,
    HomeDirError = 903,
    ParentDirError = 904,
    PathUtf8Error(String),
    SerdeJsonError(Error),
    SerdeYamlError(Error),
    VerifyError(String),
    CoreError(Error),
    ExternalError(String),
    FFINulError(NulError),
    FFICStrError(Utf8Error),
    FFINulPtrError = 1_205,
    FFIFromUtf8Error(FromUtf8Error),
    BackendError(String),
    ExtensionError(String),
    DetachedExtensionTaskClosed = 1_503,
    OnionRouteError(OnionRouteError),
    OnionProxyIoError(String),
    OnionProxyRequestTimedOut = 1_603,
    OnionQueueAdmission {
        queue: OnionQueueKind,
        peer: Did,
        reason: OnionQueueAdmissionReason,
    },
    OnionProxyTarget(OnionProxyTargetError),
    OnionTargetResolve {
        authority: String,
        source: Error,
    },
    OnionTargetResolvedEmpty {
        authority: String,
    },
}

Errors enum mapping global custom errors. The error type can be expressed in decimal, where the high decs represent the error category and the low decs represent the error type.

Variants (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.

RemoteRpcError(String)

Connecting to a remote JSON-RPC server failed.

UnknownRpcError = 101

A remote JSON-RPC error did not match a known local variant.

InternalRpcError(Error)

The internal JSON-RPC dispatcher returned an error.

UuidError(Error)

UUID parsing or formatting failed.

ConnectionNotFound = 203

The requested connection does not exist in the local swarm.

NewConnectionError(Error)

Opening a new connection through the core swarm failed.

CloseConnectionError(Error)

Closing an existing connection through the core swarm failed.

InvalidConnectionId = 206

The supplied connection identifier is malformed or unknown.

CreateOffer(Error)

Creating WebRTC offer data failed.

AnswerOffer(Error)

Creating WebRTC answer data failed.

AcceptAnswer(Error)

Accepting WebRTC answer data failed.

DecodeError = 300

Decoding structured data failed.

EncodeError = 301

Encoding structured data failed.

WasmCompileError(String)

Compiling a WASM artifact failed.

WasmBackendMessageRwLockError = 401

Acquiring the WASM backend-message lock failed.

WasmInstantiationError = 402

Instantiating a WASM module failed.

WasmExportError = 403

Resolving a required WASM export failed.

WasmRuntimeError(String)

Executing WASM code returned a runtime error.

WasmGlobalMemoryLockError = 405

Acquiring the WASM global memory lock failed.

WasmFailedToLoadFile = 406

Loading a WASM input file failed.

InvalidDid(String)

Parsing or validating a DID failed.

InvalidMethod = 501

The requested JSON-RPC method is not supported.

InternalError(Error)

A core internal operation failed.

NoPermission = 504

The caller is not authorized to perform the requested action.

ConnectError(Error)

Connecting to a peer failed.

SendMessage(Error)

Sending a peer message failed.

EntryError(Error)

Applying a DHT entry action failed.

ServiceRegisterError(Error)

Registering a service descriptor failed.

JsError(String)

JavaScript host code returned an error.

InvalidMessage = 800

A protocol message failed validation.

HttpRequestError(String)

An HTTP proxy request failed validation.

InvalidData = 802

Input data failed semantic validation.

InvalidService = 803

A service name or service descriptor is invalid.

InvalidAddress = 804

A network address is invalid.

InvalidAuthData = 805

Authentication payload data is invalid.

InvalidHeaders = 806

Request headers are missing required values or contain invalid values.

Storage(Error)

Persistent or cache storage returned an error.

Swarm(Error)

Swarm state management returned an error.

InvalidLoggingLevel(String)

The requested logging level is not supported.

InvalidWebrtcUdpPortRange(WebrtcUdpPortRangeError)

The configured WebRTC UDP port range is invalid.

IncompleteWebrtcUdpPortRange

Only one side of the WebRTC UDP port range was configured.

Fields

min: Option<u16>

Configured lower UDP port bound.

max: Option<u16>

Configured upper UDP port bound.

InvalidConfig(String)

The node configuration is structurally invalid.

BrowserStorageOpen

Opening browser IndexedDB-backed provider storage failed.

Fields

name: String

IndexedDB database and object-store name requested by the browser provider.

source: Error

Storage backend error returned while opening the database.

RegistrationStopped = 815

A periodic registration task observed a cooperative stop request.

MeasurementRuntime(MeasureRuntimeError)

Loading or explicitly flushing local peer measurements failed.

CreateFileError(String)

Creating a file on disk failed.

OpenFileError(String)

Opening a file on disk failed.

Lock = 902

Acquiring a synchronization lock failed.

HomeDirError = 903

The process home directory could not be resolved.

ParentDirError = 904

The parent directory of a path could not be resolved.

PathUtf8Error(String)

A filesystem path cannot be represented as UTF-8.

SerdeJsonError(Error)

JSON serialization or deserialization failed.

SerdeYamlError(Error)

YAML serialization or deserialization failed.

VerifyError(String)

Cryptographic verification failed.

CoreError(Error)

A rings-core operation returned an error.

ExternalError(String)

An external signer returned an error.

FFINulError(NulError)

An FFI string contained an interior nul byte.

FFICStrError(Utf8Error)

Converting an FFI C string to UTF-8 failed.

FFINulPtrError = 1_205

An FFI pointer argument was null.

FFIFromUtf8Error(FromUtf8Error)

Converting owned FFI bytes to UTF-8 failed.

BackendError(String)

A protocol backend returned an error.

ExtensionError(String)

An extension runtime returned an error.

DetachedExtensionTaskClosed = 1_503

An owned extension task ended before publishing its result.

OnionRouteError(OnionRouteError)

Onion route construction or validation failed.

OnionProxyIoError(String)

Onion proxy I/O failed.

OnionProxyRequestTimedOut = 1_603

A local onion proxy request did not complete before its deadline.

OnionQueueAdmission

A bounded onion or relay send queue rejected one item.

Fields

queue: OnionQueueKind

Queue whose bound was reached.

peer: Did

Peer whose item was rejected.

reason: OnionQueueAdmissionReason

Exact admission relation that failed.

OnionProxyTarget(OnionProxyTargetError)

An onion proxy authority failed closed parsing.

OnionTargetResolve

Runtime DNS resolution of an admitted onion target failed.

Fields

authority: String

Canonical target authority.

source: Error

Resolver I/O failure.

OnionTargetResolvedEmpty

Runtime DNS resolution returned no addresses.

Fields

authority: String

Canonical target authority.

Implementations

impl Error

pub fn code(&self) -> u32

Returns the stable numeric error code for JSON-RPC error conversion.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<FromUtf8Error> for Error

fn from(source: FromUtf8Error) -> Self

Converts to this type from the input type.

impl From<MeasureRuntimeError> for Error

fn from(source: MeasureRuntimeError) -> Self

Converts to this type from the input type.

impl From<NulError> for Error

fn from(source: NulError) -> Self

Converts to this type from the input type.

impl From<OnionProxyTargetError> for Error

fn from(source: OnionProxyTargetError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for Error

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.

impl From<WebrtcUdpPortRangeError> for Error

fn from(source: WebrtcUdpPortRangeError) -> Self

Converts to this type from the input type.