#[non_exhaustive]
pub enum ErrorDetail {
Show 32 variants ChanMgrSetup(Error), GuardMgrSetup(GuardMgrError), 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.
Expand description

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

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

ChanMgrSetup(Error)

Error setting up the channel manager

§

GuardMgrSetup(GuardMgrError)

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

Fields

§exit_ports: Sensitive<TargetPorts>

The ports that we wanted a circuit for.

§cause: Error

What went wrong

Failed to obtain exit circuit

§

ObtainHsCircuit

Fields

§hsid: Redacted<HsId>

The service we were trying to connect to

§cause: ConnError

What went wrong

Available on crate feature onion-service-client only.

Failed to obtain hidden service circuit

§

DirMgrBootstrap(Error)

Directory manager was unable to bootstrap a working directory.

§

StreamFailed

Fields

§kind: &'static str

What kind of stream we were trying to launch.

§cause: Error

The error that occurred.

A protocol error while launching a stream

§

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

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.

§

NoDir

Fields

§error: Error

The underlying error.

§action: &'static str

What we were trying to do that needed a directory.

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

§

Keystore(Error)

A key store access failed.

§

KeystoreRequired

Fields

§action: &'static str

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

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

§

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.

§

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§

source§

impl ErrorDetail

source

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

Construct a new Error from a SpawnError.

Trait Implementations§

source§

impl Clone for ErrorDetail

source§

fn clone(&self) -> ErrorDetail

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ErrorDetail

source§

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

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

impl Display for ErrorDetail

source§

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

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

impl Error for ErrorDetail

source§

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

The lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

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. Read more
source§

impl From<ArtiPathSyntaxError> for ErrorDetail

source§

fn from(source: ArtiPathSyntaxError) -> Self

Converts to this type from the input type.
source§

impl From<Bug> for ErrorDetail

source§

fn from(source: Bug) -> Self

Converts to this type from the input type.
source§

impl From<ConfigBuildError> for ErrorDetail

source§

fn from(source: ConfigBuildError) -> Self

Converts to this type from the input type.
source§

impl From<Error> for ErrorDetail

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for ErrorDetail

source§

fn from(source: Error) -> Self

Converts to this type from the input type.
source§

impl From<ErrorDetail> for Error

source§

fn from(detail: ErrorDetail) -> Error

Converts to this type from the input type.
source§

impl From<HsIdParseError> for ErrorDetail

source§

fn from(source: HsIdParseError) -> Self

Converts to this type from the input type.
source§

impl From<PtError> for ErrorDetail

source§

fn from(source: PtError) -> Self

Converts to this type from the input type.
source§

impl From<ReconfigureError> for ErrorDetail

source§

fn from(source: ReconfigureError) -> Self

Converts to this type from the input type.
source§

impl From<StartupError> for ErrorDetail

source§

fn from(source: StartupError) -> Self

Converts to this type from the input type.
source§

impl From<StartupError> for ErrorDetail

source§

fn from(source: StartupError) -> Self

Converts to this type from the input type.
source§

impl From<TorAddrError> for ErrorDetail

source§

fn from(e: TorAddrError) -> ErrorDetail

Converts to this type from the input type.
source§

impl HasKind for ErrorDetail

source§

fn kind(&self) -> ErrorKind

Return the kind of this error.

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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> DynClone for T
where T: Clone,

source§

impl<E> ErrorReport for E
where E: Error + 'static,

source§

fn report(&self) -> Report<ReportHelper<'_>>

Return an object that displays the error and its causes
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where T: Clone,

§

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§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

impl<T> TryIntoSlug for T
where T: ToString + ?Sized,

source§

fn try_into_slug(&self) -> Result<Slug, BadSlug>

Convert self into a Slug, if it has the right syntax
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more