Enum RelayFlag 

#[non_exhaustive]
pub enum RelayFlag {
    Authority,
    BadExit,
    Exit,
    Fast,
    Guard,
    HSDir,
    MiddleOnly,
    NoEdConsensus,
    Stable,
    StaleDesc,
    Running,
    Valid,
    V2Dir,
}

Router status flags - one recognized directory flag on a single relay.

https://spec.torproject.org/dir-spec/consensus-formats.html#item:s

These flags come from a consensus directory document, and are used to describe what the authorities believe about the relay. If the document contained any flags that we didn’t recognize, they are not listed in this type.

TODO SPEC: Make the terminology the same everywhere.

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.

Authority

Is this a directory authority?

BadExit

Is this relay marked as a bad exit?

Bad exits can be used as intermediate relays, but not to deliver traffic.

Exit

Is this relay marked as an exit for weighting purposes?

Fast

Is this relay considered “fast” above a certain threshold?

Guard

Is this relay suitable for use as a guard relay?

Clients choose their their initial relays from among the set of Guard relays.

HSDir

Does this relay participate on the onion service directory ring?

MiddleOnly

Set if this relay is considered “middle only”, not suitable to run as an exit or guard relay.

Note that this flag is only used by authorities as part of the voting process; clients do not and should not act based on whether it is set.

NoEdConsensus

If set, there is no consensus for the ed25519 key for this relay.

Stable

Is this relay considered “stable” enough for long-lived circuits?

StaleDesc

Set if the authorities are requesting a fresh descriptor for this relay.

Running

Set if this relay is currently running.

This flag can appear in votes, but in consensuses, every relay is assumed to be running.

Valid

Set if this relay is considered “valid” – allowed to be on the network.

This flag can appear in votes, but in consensuses, every relay is assumed to be valid.

V2Dir

Set if this relay supports a currently recognized version of the directory protocol.

Trait Implementations

impl<O: Into<EnumSet<RelayFlag>>> BitAnd<O> for RelayFlag

type Output = EnumSet<RelayFlag>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> Self::Output

Performs the & operation.

impl<O: Into<EnumSet<RelayFlag>>> BitOr<O> for RelayFlag

type Output = EnumSet<RelayFlag>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> Self::Output

Performs the | operation.

impl<O: Into<EnumSet<RelayFlag>>> BitXor<O> for RelayFlag

type Output = EnumSet<RelayFlag>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> Self::Output

Performs the ^ operation.

impl Clone for RelayFlag

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayFlag

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

Formats the value using the given formatter.

impl Display for RelayFlag

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

Formats the value using the given formatter.

impl EnumSetConstHelper for RelayFlag

const CONST_INIT_HELPER: __EnumSetInitHelper = __EnumSetInitHelper

The instance of the ConstInitHelper.

const CONST_OP_HELPER: __EnumSetOpHelper = __EnumSetOpHelper

The instance of the ConstOpHelper.

type ConstInitHelper = __EnumSetInitHelper

A helper type used to convert values to EnumSets at compile-time.

type ConstOpHelper = __EnumSetOpHelper

A helper type used to implement compile-time operations on enums.

impl EnumSetTypePrivate for RelayFlag

const ALL_BITS: Self::Repr = 8191

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 13u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 13u32

The number of variants in the bitset.

type Repr = u16

The underlying type used to store the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

unsafe fn enum_from_u32_checked(val: u32) -> Self

Converts a bit position into an enum value, with an debug_assert.

impl EnumSetTypeWithRepr for RelayFlag

type Repr = u16

The guaranteed representation.

impl<'_derivative_strum> From<&'_derivative_strum RelayFlag> for &'static str

fn from(x: &'_derivative_strum RelayFlag) -> &'static str

Converts to this type from the input type.

impl From<RelayFlag> for &'static str

fn from(x: RelayFlag) -> &'static str

Converts to this type from the input type.

impl FromStr for RelayFlag

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<RelayFlag, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Not for RelayFlag

type Output = EnumSet<RelayFlag>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<EnumSet<RelayFlag>> for RelayFlag

fn eq(&self, other: &EnumSet<RelayFlag>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for RelayFlag

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<O: Into<EnumSet<RelayFlag>>> Sub<O> for RelayFlag

type Output = EnumSet<RelayFlag>

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self::Output

Performs the - operation.

impl TryFrom<&str> for RelayFlag

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<RelayFlag, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for RelayFlag

impl EnumSetType for RelayFlag

impl Eq for RelayFlag