Enum arti_client::ErrorDetail

#[non_exhaustive]
pub enum ErrorDetail {
    ChanMgrSetup(Error),
    CircMgrSetup(Error),
    ObtainExitCircuit {
        exit_ports: TargetPorts,
        cause: Error,
    },
    DirMgr(Error),
    Proto(Error),
    Persist(Error),
    ExitTimeout,
    OnionAddressNotSupported,
    Address(TorAddrError),
    InvalidHostname,
    LocalAddress,
    Configuration(ConfigBuildError),
    Reconfigure(ReconfigureError),
    Spawn {
        spawning: &'static str,
        cause: Arc<SpawnError>,
    },
    BootstrapRequired {
        action: &'static str,
    },
}

Represents errors that can occur while doing Tor operations.

This enumeration is the inner view of a arti_client::Error: we don’t expose it unless the error_detail feature is enabled.

The details of this enumeration are not stable: using the error_detail feature will void your semver guarantee.

Instead of looking at the type, you try to should use the kind trait method to distinguish among different kinds of Error. If that doesn’t provide enough information for your use case, please let us know.

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.

ChanMgrSetup(Error)

Error setting up the channel manager

CircMgrSetup(Error)

Error setting up the circuit manager

ObtainExitCircuit

Fields

exit_ports: TargetPorts

What for

cause: Error

What went wrong

Failed to obtain exit circuit

DirMgr(Error)

Error while getting a circuit

Proto(Error)

A protocol error while launching a stream

Persist(Error)

An error while interfacing with the persistent data layer.

ExitTimeout

We asked an exit to do something, and waited too long for an answer..

OnionAddressNotSupported

Onion services not supported.

Address(TorAddrError)

Unusable target address.

InvalidHostname

Hostname not valid.

LocalAddress

Address was local, and that’s not allowed.

Configuration(ConfigBuildError)

Building configuration for the client failed.

Reconfigure(ReconfigureError)

Unable to change configuration.

Spawn

Fields

spawning: &'static str

What we were trying to spawn.

cause: Arc<SpawnError>

What happened when we tried to spawn it.

Unable to spawn task

BootstrapRequired

Fields

action: &'static str

What we were trying to do that required bootstrapping.

Attempted to use an unbootstrapped TorClient for something that requires bootstrapping to have completed.

Trait Implementations

impl Clone for ErrorDetail

fn clone(&self) -> ErrorDetail

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ErrorDetail

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

Formats the value using the given formatter.

impl Display for ErrorDetail

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

Formats the value using the given formatter.

impl Error for ErrorDetail

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

impl From<ConfigBuildError> for ErrorDetail

fn from(source: ConfigBuildError) -> Self

Converts to this type from the input type.

impl From<Error> for ErrorDetail

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ErrorDetail

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for ErrorDetail

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ErrorDetail> for Error

fn from(detail: ErrorDetail) -> Error

Converts to this type from the input type.

impl From<ReconfigureError> for ErrorDetail

fn from(source: ReconfigureError) -> Self

Converts to this type from the input type.

impl From<TorAddrError> for ErrorDetail

fn from(source: TorAddrError) -> Self

Converts to this type from the input type.

impl HasKind for ErrorDetail

fn kind(&self) -> ErrorKind

Return the kind of this error.