Struct tor_netdoc::doc::netstatus::RelayFlags

pub struct RelayFlags(_);

A set of recognized directory flags on a single relay.

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.

The bit values used to represent the flags have no meaning; they may change between releases of this crate. Relying on their values may void your semver guarantees.

Implementations

impl RelayFlags

pub const AUTHORITY: Self = _

Is this a directory authority?

pub const BAD_EXIT: Self = _

Is this relay marked as a bad exit?

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

pub const EXIT: Self = _

Is this relay marked as an exit for weighting purposes?

pub const FAST: Self = _

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

pub const GUARD: Self = _

Is this relay suitable for use as a guard relay?

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

pub const HSDIR: Self = _

Does this relay participate on the onion service directory ring?

pub const MIDDLE_ONLY: Self = _

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.

pub const NO_ED_CONSENSUS: Self = _

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

pub const STABLE: Self = _

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

pub const STALE_DESC: Self = _

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

pub const RUNNING: Self = _

Set if this relay is currently running.

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

pub const VALID: Self = _

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.

pub const V2DIR: Self = _

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

impl RelayFlags

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u16) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u16) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const fn from_bits_retain(bits: u16) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub fn from_name(name: &str) -> Option<Self>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

pub const fn iter(&self) -> Iter

Iterate over enabled flag values.

pub const fn iter_names(&self) -> IterRaw

Iterate over enabled flag values with their stringified names.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for RelayFlags

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

Formats the value using the given formatter.

impl BitAnd<RelayFlags> for RelayFlags

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

Returns the intersection between the two sets of flags.

type Output = RelayFlags

The resulting type after applying the & operator.

impl BitAndAssign<RelayFlags> for RelayFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitFlags for RelayFlags

type Bits = u16

The underlying integer type.

type Iter = Iter

An iterator over enabled flags in an instance of the type.

type IterNames = IterRaw

An iterator over the raw names and bits for enabled flags in an instance of the type.

fn empty() -> Self

Returns an empty set of flags.

fn all() -> Self

Returns the set containing all flags.

fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

fn from_bits(bits: u16) -> Option<RelayFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

fn from_bits_truncate(bits: u16) -> RelayFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

fn from_bits_retain(bits: u16) -> RelayFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

fn from_name(name: &str) -> Option<RelayFlags>

Get the flag for a particular name.

fn iter(&self) -> Self::Iter

Iterate over enabled flag values.

fn iter_names(&self) -> Self::IterNames

Iterate over the raw names and bits for enabled flag values.

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

fn is_all(&self) -> bool

Returns true if all flags are currently set.

fn intersects(&self, other: RelayFlags) -> bool

Returns true if there are flags common to both self and other.

fn contains(&self, other: RelayFlags) -> bool

Returns true if all of the flags in other are contained within self.

fn insert(&mut self, other: RelayFlags)

Inserts the specified flags in-place.

fn remove(&mut self, other: RelayFlags)

Removes the specified flags in-place.

fn toggle(&mut self, other: RelayFlags)

Toggles the specified flags in-place.

fn set(&mut self, other: RelayFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

impl BitOr<RelayFlags> for RelayFlags

fn bitor(self, other: RelayFlags) -> Self

Returns the union of the two sets of flags.

type Output = RelayFlags

The resulting type after applying the | operator.

impl BitOrAssign<RelayFlags> for RelayFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<RelayFlags> for RelayFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = RelayFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<RelayFlags> for RelayFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for RelayFlags

fn clone(&self) -> RelayFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RelayFlags

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

Formats the value using the given formatter.

impl Extend<RelayFlags> for RelayFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<RelayFlags> for RelayFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl FromStr for RelayFlags

type Err = Infallible

The associated error which can be returned from parsing.

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

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

impl IntoIterator for RelayFlags

type Item = RelayFlags

The type of the elements being iterated over.

type IntoIter = Iter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for RelayFlags

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

Formats the value using the given formatter.

impl Not for RelayFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = RelayFlags

The resulting type after applying the ! operator.

impl Octal for RelayFlags

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

Formats the value using the given formatter.

impl PublicFlags for RelayFlags

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub<RelayFlags> for RelayFlags

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

Returns the set difference of the two sets of flags.

type Output = RelayFlags

The resulting type after applying the - operator.

impl SubAssign<RelayFlags> for RelayFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for RelayFlags

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

Formats the value using the given formatter.

impl Copy for RelayFlags