Struct arti_client::Error

pub struct Error { /* private fields */ }

Main high-level error type for the Arti Tor client

If you need to handle different types of errors differently, use the kind trait method to check what kind of error it is.

Note that although this type implements that standard Error trait, the output of that trait’s methods are not covered by semantic versioning. Specifically: you should not rely on the specific output of Display, Debug, or Error::source() when run on this type; it may change between patch versions without notification.

Implementations

impl Error

pub fn detail(&self) -> &ErrorDetail

Return the underlying error detail object for this error.

In general, it’s not a good idea to use this function. Our arti_client::ErrorDetail objects are unstable, and matching on them is probably not the best way to achieve whatever you’re trying to do. Instead, we recommend using the kind trait method if your program needs to distinguish among different types of errors.

(If the above function don’t meet your needs, please let us know!)

This function is only available when arti-client is built with the error_detail feature. Using this function will void your semver guarantees.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

fn from(detail: ErrorDetail) -> Error

Converts to this type from the input type.

impl From<TorAddrError> for Error

fn from(e: TorAddrError) -> Error

Converts to this type from the input type.

impl HasKind for Error

fn kind(&self) -> ErrorKind

Return the kind of this error.