Enum Error

#[non_exhaustive]
pub enum Error {
    BytesErr {
        object: &'static str,
        err: Error,
    },
    ChanIoErr(Arc<Error>),
    HandshakeIoErr(Arc<Error>),
    CellEncodeErr {
        object: &'static str,
        err: Error,
    },
    CellDecodeErr {
        object: &'static str,
        err: Error,
    },
    EncodeErr {
        object: &'static str,
        err: EncodeError,
    },
    HandshakeCertErr(CertError),
    InvalidKDFOutputLength,
    NoSuchHop,
    BadCellAuth,
    BadCircHandshakeAuth,
    HandshakeProto(String),
    HandshakeCertsExpired {
        expired_by: Duration,
    },
    ChanProto(String),
    CircProto(String),
    ChannelClosed(ChannelClosed),
    CircuitClosed,
    IdRangeFull,
    IdUnavailable(StreamId),
    StreamIdZero,
    CircRefused(&'static str),
    BadStreamAddress,
    EndReceived(EndReason),
    NotConnected,
    StreamProto(String),
    ChanMismatch(String),
    Bug(Bug),
    ResolveError(ResolveError),
    MissingId(RelayIdType),
    Memquota(Error),
}

An error type for the tor-proto crate.

This type should probably be split into several. There’s more than one kind of error that can occur while doing something with the Tor protocol.

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.

BytesErr

An error that occurred in the tor_bytes crate while decoding an object.

Fields

object: &'static str

What we were trying to parse.

err: Error

The error that occurred while parsing it.

ChanIoErr(Arc<Error>)

An error that occurred from the io system when using a channel.

HandshakeIoErr(Arc<Error>)

An error from the io system that occurred when trying to connect a channel.

CellEncodeErr

An error occurred while trying to create or encode a cell.

Fields

object: &'static str

The object we were trying to create or encode.

err: Error

The error that occurred.

CellDecodeErr

An error occurred while trying to decode or parse a cell.

Fields

object: &'static str

The object we were trying to decode.

err: Error

The error that occurred.

EncodeErr

An error occurred while trying to create or encode some non-cell message.

This is likely the result of a bug: either in this crate, or the code that provided the input.

Fields

object: &'static str

What we were trying to create or encode.

err: EncodeError

The error that occurred.

HandshakeCertErr(CertError)

We found a problem with one of the certificates in the channel handshake.

InvalidKDFOutputLength

We tried to produce too much output for a key derivation function.

NoSuchHop

We tried to encrypt a message to a hop that wasn’t there.

BadCellAuth

The authentication information on this cell was completely wrong, or the cell was corrupted.

BadCircHandshakeAuth

A circuit-extension handshake failed due to a mismatched authentication value.

HandshakeProto(String)

Handshake protocol violation.

HandshakeCertsExpired

Handshake broken, maybe due to clock skew.

(If the problem can’t be due to clock skew, we return HandshakeProto instead.)

Fields

expired_by: Duration

For how long has the circuit been expired?

ChanProto(String)

Protocol violation at the channel level, other than at the handshake stage.

CircProto(String)

Protocol violation at the circuit level

ChannelClosed(ChannelClosed)

Channel is closed, or became closed while we were trying to do some operation.

CircuitClosed

Circuit is closed, or became closed while we were trying to so some operation.

IdRangeFull

Can’t allocate any more circuit or stream IDs on a channel.

IdUnavailable(StreamId)

Received a stream request with a stream ID that is already in use for another stream.

StreamIdZero

Received a cell with a stream ID of zero.

CircRefused(&'static str)

Couldn’t extend a circuit because the extending relay or the target relay refused our request.

BadStreamAddress

Tried to make or use a stream to an invalid destination address.

EndReceived(EndReason)

Received an End cell from the other end of a stream.

NotConnected

Stream was already closed when we tried to use it.

StreamProto(String)

Stream protocol violation

ChanMismatch(String)

Channel does not match target

Bug(Bug)

There was a programming error somewhere in our code, or the calling code.

ResolveError(ResolveError)

Remote DNS lookup failed.

MissingId(RelayIdType)

We tried to do something with a that we couldn’t, because of an identity key type that the relay doesn’t have.

Memquota(Error)

Memory quota error

Implementations

impl Error

pub(crate) fn from_cell_enc(err: Error, object: &'static str) -> Error

Create an error from a tor_cell error that has occurred while trying to encode or create something of type object

pub(crate) fn from_cell_dec(err: Error, object: &'static str) -> Error

Create an error from a tor_cell error that has occurred while trying to decode something of type object

pub(crate) fn from_bytes_err(err: Error, object: &'static str) -> Error

Create an error for a tor_bytes error that occurred while parsing something of type object.

pub(crate) fn from_bytes_enc(err: EncodeError, object: &'static str) -> Error

Create an error for a tor_bytes error that occurred while encoding something of type object.

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, __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<Bug> for Error

fn from(source: Bug) -> Self

Converts to this type from the input type.

impl From<ChannelClosed> for Error

fn from(source: ChannelClosed) -> 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(err: Error) -> Error

Converts to this type from the input type.

impl From<Error> for ReactorError

fn from(e: Error) -> ReactorError

Converts to this type from the input type.

impl HasKind for Error

fn kind(&self) -> ErrorKind

Return the kind of this error.