Struct tor_netdoc::doc::netstatus::RelayFlags
source · [−]pub struct RelayFlags { /* private fields */ }
Expand description
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.
Implementations
sourceimpl RelayFlags
impl RelayFlags
sourcepub const BAD_EXIT: Self = Self{bits: 1 << 1,}
pub const BAD_EXIT: Self = Self{bits: 1 << 1,}
Is this relay marked as a bad exit?
Bad exits can be used as intermediate relays, but not to deliver traffic.
sourcepub const EXIT: Self = Self{bits: 1 << 2,}
pub const EXIT: Self = Self{bits: 1 << 2,}
Is this relay marked as an exit for weighting purposes?
sourcepub const FAST: Self = Self{bits: 1 << 3,}
pub const FAST: Self = Self{bits: 1 << 3,}
Is this relay considered “fast” above a certain threshold?
sourcepub const GUARD: Self = Self{bits: 1 << 4,}
pub const GUARD: Self = Self{bits: 1 << 4,}
Is this relay suitable for use as a guard relay?
Clients choose their their initial relays from among the set of Guard relays.
sourcepub const HSDIR: Self = Self{bits: 1 << 5,}
pub const HSDIR: Self = Self{bits: 1 << 5,}
Does this relay participate on the onion service directory ring?
sourcepub const NO_ED_CONSENSUS: Self = Self{bits: 1 << 6,}
pub const NO_ED_CONSENSUS: Self = Self{bits: 1 << 6,}
If set, there is no consensus for the ed25519 key for this relay.
sourcepub const STABLE: Self = Self{bits: 1 << 7,}
pub const STABLE: Self = Self{bits: 1 << 7,}
Is this relay considered “stable” enough for long-lived circuits?
sourcepub const STALE_DESC: Self = Self{bits: 1 << 8,}
pub const STALE_DESC: Self = Self{bits: 1 << 8,}
Set if the authorities are requesting a fresh descriptor for this relay.
sourcepub const RUNNING: Self = Self{bits: 1 << 9,}
pub const RUNNING: Self = Self{bits: 1 << 9,}
Set if this relay is currently running.
This flag can appear in votes, but in consensuses, every relay is assumed to be running.
sourcepub const VALID: Self = Self{bits: 1 << 10,}
pub const VALID: Self = Self{bits: 1 << 10,}
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.
sourcepub const V2DIR: Self = Self{bits: 1 << 11,}
pub const V2DIR: Self = Self{bits: 1 << 11,}
Set if this relay supports a currently recognized version of the directory protocol.
sourcepub const fn from_bits(bits: u16) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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
.
sourcepub const fn union(self, other: Self) -> Self
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
.
sourcepub const fn difference(self, other: Self) -> Self
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
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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
.
sourcepub const fn complement(self) -> Self
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
sourceimpl Binary for RelayFlags
impl Binary for RelayFlags
sourceimpl BitAnd<RelayFlags> for RelayFlags
impl BitAnd<RelayFlags> for RelayFlags
type Output = RelayFlags
type Output = RelayFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<RelayFlags> for RelayFlags
impl BitAndAssign<RelayFlags> for RelayFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<RelayFlags> for RelayFlags
impl BitOr<RelayFlags> for RelayFlags
sourcefn bitor(self, other: RelayFlags) -> Self
fn bitor(self, other: RelayFlags) -> Self
Returns the union of the two sets of flags.
type Output = RelayFlags
type Output = RelayFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<RelayFlags> for RelayFlags
impl BitOrAssign<RelayFlags> for RelayFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<RelayFlags> for RelayFlags
impl BitXor<RelayFlags> for RelayFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = RelayFlags
type Output = RelayFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<RelayFlags> for RelayFlags
impl BitXorAssign<RelayFlags> for RelayFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for RelayFlags
impl Clone for RelayFlags
sourcefn clone(&self) -> RelayFlags
fn clone(&self) -> RelayFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for RelayFlags
impl Debug for RelayFlags
sourceimpl Extend<RelayFlags> for RelayFlags
impl Extend<RelayFlags> for RelayFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<RelayFlags> for RelayFlags
impl FromIterator<RelayFlags> for RelayFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl FromStr for RelayFlags
impl FromStr for RelayFlags
sourceimpl Hash for RelayFlags
impl Hash for RelayFlags
sourceimpl LowerHex for RelayFlags
impl LowerHex for RelayFlags
sourceimpl Not for RelayFlags
impl Not for RelayFlags
type Output = RelayFlags
type Output = RelayFlags
The resulting type after applying the !
operator.
sourceimpl Octal for RelayFlags
impl Octal for RelayFlags
sourceimpl Ord for RelayFlags
impl Ord for RelayFlags
sourceimpl PartialEq<RelayFlags> for RelayFlags
impl PartialEq<RelayFlags> for RelayFlags
sourcefn eq(&self, other: &RelayFlags) -> bool
fn eq(&self, other: &RelayFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &RelayFlags) -> bool
fn ne(&self, other: &RelayFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<RelayFlags> for RelayFlags
impl PartialOrd<RelayFlags> for RelayFlags
sourcefn partial_cmp(&self, other: &RelayFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &RelayFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<RelayFlags> for RelayFlags
impl Sub<RelayFlags> for RelayFlags
type Output = RelayFlags
type Output = RelayFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<RelayFlags> for RelayFlags
impl SubAssign<RelayFlags> for RelayFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for RelayFlags
impl UpperHex for RelayFlags
impl Copy for RelayFlags
impl Eq for RelayFlags
impl StructuralEq for RelayFlags
impl StructuralPartialEq for RelayFlags
Auto Trait Implementations
impl RefUnwindSafe for RelayFlags
impl Send for RelayFlags
impl Sync for RelayFlags
impl Unpin for RelayFlags
impl UnwindSafe for RelayFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more