Enum ErrorDetail

#[non_exhaustive]
pub enum ErrorDetail {
    MemquotaSetup(StartupError),
    MemquotaDuringStartup(Error),
    ChanMgrSetup(Error),
    GuardMgrSetup(GuardMgrError),
    VanguardMgrSetup(VanguardMgrError),
    CircMgrSetup(Error),
    BridgeDescMgrSetup(StartupError),
    DirMgrSetup(Error),
    StateMgrSetup(Error),
    HsClientConnectorSetup(StartupError),
    ObtainExitCircuit {
        exit_ports: Sensitive<TargetPorts>,
        cause: Error,
    },
    ObtainHsCircuit {
        hsid: Redacted<HsId>,
        cause: ConnError,
    },
    DirMgrBootstrap(Error),
    StreamFailed {
        kind: &'static str,
        cause: Error,
    },
    StateAccess(Error),
    ExitTimeout,
    OnionAddressNotSupported,
    OnionAddressDisabled,
    OnionAddressResolveRequest,
    Address(TorAddrError),
    InvalidHostname,
    LocalAddress,
    Configuration(ConfigBuildError),
    Reconfigure(ReconfigureError),
    PluggableTransport(PtError),
    FsMistrust(Error),
    Spawn {
        spawning: &'static str,
        cause: Arc<SpawnError>,
    },
    BootstrapRequired {
        action: &'static str,
    },
    NoDir {
        error: Error,
        action: &'static str,
    },
    Keystore(Error),
    KeystoreRequired {
        action: &'static str,
    },
    BadClientSpecifier(ArtiPathSyntaxError),
    BadOnionAddress(HsIdParseError),
    LaunchOnionService(StartupError),
    Bug(Bug),
}

Available on crate feature error_detail only.

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 should try to 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.

MemquotaSetup(StartupError)

Error setting up the memory quota tracker

MemquotaDuringStartup(Error)

Memory quota error while starting up Arti

ChanMgrSetup(Error)

Error setting up the channel manager

GuardMgrSetup(GuardMgrError)

Error setting up the guard manager

VanguardMgrSetup(VanguardMgrError)

Available on crate feature vanguards and (crate features onion-service-client or onion-service-service) only.

Error setting up the guard manager

CircMgrSetup(Error)

Error setting up the circuit manager

BridgeDescMgrSetup(StartupError)

Available on crate feature bridge-client only.

Error setting up the bridge descriptor manager

DirMgrSetup(Error)

Error setting up the directory manager

StateMgrSetup(Error)

Error setting up the state manager.

HsClientConnectorSetup(StartupError)

Available on crate feature onion-service-client only.

Error setting up the hidden service client connector.

ObtainExitCircuit

Failed to obtain exit circuit

Fields

exit_ports: Sensitive<TargetPorts>

The ports that we wanted a circuit for.

cause: Error

What went wrong

ObtainHsCircuit

Available on crate feature onion-service-client only.

Failed to obtain hidden service circuit

Fields

hsid: Redacted<HsId>

The service we were trying to connect to

cause: ConnError

What went wrong

DirMgrBootstrap(Error)

Directory manager was unable to bootstrap a working directory.

StreamFailed

A protocol error while launching a stream

Fields

kind: &'static str

What kind of stream we were trying to launch.

cause: Error

The error that occurred.

StateAccess(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 are not compiled in, but we were asked to connect to one.

OnionAddressDisabled

Available on crate feature onion-service-client only.

Onion services are not enabled, but we were asked to connect to one.

This error occurs when Arti is built with onion service support, but onion services are disabled via our stream preferences.

To enable onion services, set allow_onion_addrs to true in the address_filter configuration section. Alternatively, set connect_to_onion_services in your StreamPrefs object.

OnionAddressResolveRequest

Error when trying to find the IP address of a hidden service

Address(TorAddrError)

Unusable target address.

TorAddrError::InvalidHostname should not appear here; use ErrorDetail::InvalidHostname instead.

InvalidHostname

Hostname not valid.

LocalAddress

Address was local, and we don’t permit connecting to those over Tor.

Configuration(ConfigBuildError)

Building configuration for the client failed.

Reconfigure(ReconfigureError)

Unable to change configuration.

PluggableTransport(PtError)

Available on crate feature pt-client only.

Problem creating or launching a pluggable transport.

FsMistrust(Error)

We encountered a problem while inspecting or creating a directory.

Spawn

Unable to spawn task

Fields

spawning: &'static str

What we were trying to spawn.

cause: Arc<SpawnError>

What happened when we tried to spawn it.

BootstrapRequired

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

Fields

action: &'static str

What we were trying to do that required bootstrapping.

NoDir

Attempted to use a TorClient for something when it did not have a valid directory.

Fields

error: Error

The underlying error.

action: &'static str

What we were trying to do that needed a directory.

Keystore(Error)

A key store access failed.

KeystoreRequired

Attempted to use a TorClient for something that requires the keystore to be enabled in the configuration.

Fields

action: &'static str

What we were trying to do that required the keystore to be enabled.

BadClientSpecifier(ArtiPathSyntaxError)

Encountered a malformed client specifier.

BadOnionAddress(HsIdParseError)

Available on crate feature onion-service-client only.

We tried to parse an onion address, but we found that it was invalid.

This error occurs if we are asked to connect to an invalid .onion address.

LaunchOnionService(StartupError)

Available on crate feature onion-service-service only.

We were unable to launch an onion service, even though we we are configured to be able to do so.

Bug(Bug)

A programming problem, either in our code or the code calling it.

Implementations

impl ErrorDetail

pub(crate) fn from_spawn(spawning: &'static str, err: SpawnError) -> ErrorDetail

Construct a new Error from a SpawnError.

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)>

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<ArtiPathSyntaxError> for ErrorDetail

fn from(source: ArtiPathSyntaxError) -> Self

Converts to this type from the input type.

impl From<Bug> for ErrorDetail

fn from(source: Bug) -> Self

Converts to this type from the input type.

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<HsIdParseError> for ErrorDetail

fn from(source: HsIdParseError) -> Self

Converts to this type from the input type.

impl From<PtError> for ErrorDetail

fn from(source: PtError) -> Self

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<StartupError> for ErrorDetail

fn from(source: StartupError) -> Self

Converts to this type from the input type.

impl From<StartupError> for ErrorDetail

fn from(source: StartupError) -> Self

Converts to this type from the input type.

impl From<StartupError> for ErrorDetail

fn from(source: StartupError) -> Self

Converts to this type from the input type.

impl From<TorAddrError> for ErrorDetail

fn from(e: TorAddrError) -> ErrorDetail

Converts to this type from the input type.

impl HasKind for ErrorDetail

fn kind(&self) -> ErrorKind

Return the kind of this error.