Enum tor_netdir::WeightRole

#[non_exhaustive]
pub enum WeightRole {
    Guard,
    Middle,
    Exit,
    BeginDir,
    Unweighted,
    HsIntro,
}

Possible ways to weight relays when selecting them a random.

Relays are weighted by a function of their bandwidth that depends on how scarce that “kind” of bandwidth is. For example, if Exit bandwidth is rare, then Exits should be less likely to get chosen for the middle hop of a path.

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.

Guard

Selecting a relay to use as a guard

Middle

Selecting a relay to use as a middle relay in a circuit.

Exit

Selecting a relay to use to deliver traffic to the internet.

BeginDir

Selecting a relay for a one-hop BEGIN_DIR directory request.

Unweighted

Selecting a relay with no additional weight beyond its bandwidth.

HsIntro

Selecting a relay for use as a hidden service introduction point

Trait Implementations

impl Clone for WeightRole

fn clone(&self) -> WeightRole

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WeightRole

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

Formats the value using the given formatter.

impl Copy for WeightRole