Enum FailedAttemptError

#[non_exhaustive]
pub enum FailedAttemptError {
    UnusableIntro {
        error: InvalidTarget,
        intro_index: IntroPtIndex,
    },
    RendezvousCircuitObtain {
        error: Error,
    },
    RendezvousEstablishTimeout {
        rend_pt: Redacted<RelayIds>,
    },
    RendezvousEstablish {
        error: Error,
        rend_pt: Redacted<RelayIds>,
    },
    IntroductionCircuitObtain {
        error: Error,
        intro_index: IntroPtIndex,
    },
    IntroductionExchange {
        error: Error,
        intro_index: IntroPtIndex,
    },
    IntroductionFailed {
        status: IntroduceAckStatus,
        intro_index: IntroPtIndex,
    },
    IntroductionTimeout {
        intro_index: IntroPtIndex,
    },
    RendezvousCompletionTimeout {
        intro_index: IntroPtIndex,
        rend_pt: Redacted<RelayIds>,
    },
    RendezvousCompletionCircuitError {
        error: Error,
        intro_index: IntroPtIndex,
        rend_pt: Redacted<RelayIds>,
    },
    RendezvousCompletionHandshake {
        error: Error,
        intro_index: IntroPtIndex,
        rend_pt: Redacted<RelayIds>,
    },
    Bug(Bug),
}

Error that occurred making one attempt to connect to a hidden service using an IP and RP

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.

UnusableIntro

Introduction point unusable because it couldn’t be used as a circuit target

Fields

error: InvalidTarget

Why it’s not use able

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

RendezvousCircuitObtain

Failed to obtain any circuit to use as a rendezvous circuit

Fields

error: Error

Why it’s not use able

RendezvousEstablishTimeout

Creating a rendezvous circuit and rendezvous point took too long

Fields

rend_pt: Redacted<RelayIds>

Which relay did we choose for rendezvous point

RendezvousEstablish

Failed to establish rendezvous point

Fields

error: Error

What happened

rend_pt: Redacted<RelayIds>

Which relay did we choose for rendezvous point

IntroductionCircuitObtain

Failed to obtain circuit to introduction point

Fields

error: Error

What happened

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

IntroductionExchange

Introduction exchange (with the introduction point) failed

Fields

error: Error

What happened

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

IntroductionFailed

Introduction point reported error in its INTRODUCE_ACK

Fields

status: IntroduceAckStatus

The status code provided by the introduction point

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

IntroductionTimeout

Communication with introduction point {intro_index} took too long

This might mean it took too long to establish a circuit to the IPT, or that the INTRODUCE exchange took too long.

Fields

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

RendezvousCompletionTimeout

It took too long for the rendezvous to be completed

This might be the fault of almost anyone. All we know is that we got a successful INTRODUCE_ACK but the RENDEZVOUS2 never arrived.

Fields

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

rend_pt: Redacted<RelayIds>

Which relay did we choose for rendezvous point

RendezvousCompletionCircuitError

Error on rendezvous circuit when expecting rendezvous completion (RENDEZVOUS2)

Fields

error: Error

What happened

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

rend_pt: Redacted<RelayIds>

Which relay did we choose for rendezvous point

RendezvousCompletionHandshake

Error processing rendezvous completion (RENDEZVOUS2)

This is might be the fault of the hidden service or the rendezvous point.

Fields

error: Error

What happened

intro_index: IntroPtIndex

The index of the IPT in the list of IPTs in the descriptor

rend_pt: Redacted<RelayIds>

Which relay did we choose for rendezvous point

Bug(Bug)

Internal error

Trait Implementations

impl AsRef<dyn Error> for FailedAttemptError

fn as_ref(&self) -> &(dyn Error + 'static)

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FailedAttemptError

fn clone(&self) -> FailedAttemptError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FailedAttemptError

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

Formats the value using the given formatter.

impl Display for FailedAttemptError

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

Formats the value using the given formatter.

impl Error for FailedAttemptError

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 FailedAttemptError

fn from(source: Bug) -> Self

Converts to this type from the input type.

impl HasKind for FailedAttemptError

fn kind(&self) -> ErrorKind

Return the kind of this error.

impl HasRetryTime for FailedAttemptError

When an attempt like this should be retried.

For error variants with an introduction point index (FailedAttemptError::intro_index returns Some) that’s when we might retry with that introduction point.

For error variants with a rendezvous point, that’s when we might retry with that rendezvous point.

For variants with both, we don’t know which of the introduction point or rendezvous point is implicated. Retrying earlier with one different relay out of the two relays would be reasonable, as would delaying retrying with either of the same relays.

fn retry_time(&self) -> RetryTime

Return the time when the operation that gave this error can be retried.

fn abs_retry_time<F>(&self, now: Instant, choose_delay: F) -> AbsRetryTime

where F: FnOnce() -> Duration, Self: Sized,

Return an absolute retry when the operation that gave this error can be retried.

impl IntoDiscriminant for FailedAttemptError

type Discriminant = FailedAttemptErrorDiscriminants

Enum listing the same variants as this enum but without any data fields

fn discriminant(&self) -> Self::Discriminant