Enum tor_dirmgr::bridgedesc::Dormancy

#[non_exhaustive]
pub enum Dormancy {
    Dormant,
    Active,
}

Available on crate feature bridge-client only.

Active vs dormant state, as far as the bridge descriptor manager is concerned

This is usually derived in higher layers from arti_client::DormantMode, whether TorClient::bootstrap() has been called, etc.

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.

Dormant

Dormant (inactive)

Bridge descriptor downloads, or refreshes, will not be started.

In-progress downloads will be stopped if possible, but they may continue until they complete (or fail).

So a dormant BridgeDescMgr may still continue to change the return value from bridges() and continue to report BridgeDescEvents.

When the BridgeDescMgr is dormant, bridges() may return stale descriptors (that is, descriptors which ought to have been refetched and may no longer be valid), or stale errors (that is, errors which occurred some time ago, and which would normally have been retried by now).

Active

Active

Bridge descriptors will be downloaded as requested.

When a bridge descriptor manager has been Dormant, it may continue to provide stale data (as described) for a while after it is made Active, until the required refreshes and retries have taken place (or failed).

Trait Implementations

impl Clone for Dormancy

fn clone(&self) -> Dormancy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dormancy

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

Formats the value using the given formatter.

impl Ord for Dormancy

fn cmp(&self, other: &Dormancy) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Dormancy

fn eq(&self, other: &Dormancy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Dormancy

fn partial_cmp(&self, other: &Dormancy) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Dormancy

impl Eq for Dormancy

impl StructuralPartialEq for Dormancy