Struct tor_netdoc::doc::netstatus::NsConsensusRouterStatus

#[non_exhaustive]
pub struct NsConsensusRouterStatus {
    pub rs: GenericRouterStatus<RdDigest>,
}

Available on crate feature ns_consensus only.

A single relay’s status, as represented in a “ns” consensus.

Only available if tor-netdoc is built with the ns_consensus feature.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rs: GenericRouterStatus<RdDigest>

Available on crate feature dangerous-expose-struct-fields only.

Underlying generic routerstatus object.

This is private because we don’t want to leak that these two types have the same implementation “under the hood”.

Implementations

impl NsConsensusRouterStatus

pub fn orport_addrs(&self) -> impl Iterator<Item = &SocketAddr>

Return an iterator of ORPort addresses for this routerstatus

pub fn weight(&self) -> &RelayWeight

Return the declared weight of this routerstatus in the directory.

pub fn addrs(&self) -> &[SocketAddr]

Return the ORPort addresses of this routerstatus

pub fn protovers(&self) -> &Protocols

Return the protovers that this routerstatus says it implements.

pub fn nickname(&self) -> &str

Return the nickname of this routerstatus.

pub fn flags(&self) -> &RelayFlags

Return the relay flags of this routerstatus.

pub fn version(&self) -> Option<&Version>

Return the version of this routerstatus.

pub fn ed25519_id_is_usable(&self) -> bool

Return true if the ed25519 identity on this relay reflects a true consensus among the authorities.

pub fn is_flagged_bad_exit(&self) -> bool

Return true if this routerstatus is listed with the BadExit flag.

pub fn is_flagged_v2dir(&self) -> bool

Return true if this routerstatus is listed with the v2dir flag.

pub fn is_flagged_exit(&self) -> bool

Return true if this routerstatus is listed with the Exit flag.

pub fn is_flagged_guard(&self) -> bool

Return true if this routerstatus is listed with the Guard flag.

pub fn is_flagged_hsdir(&self) -> bool

Return true if this routerstatus is listed with the HSDir flag.

pub fn is_flagged_stable(&self) -> bool

Return true if this routerstatus is listed with the Stable flag.

pub fn is_flagged_fast(&self) -> bool

Return true if this routerstatus is listed with the Fast flag.

pub fn is_flagged_middle_only(&self) -> bool

Return true if this routerstatus is listed with the MiddleOnly flag.

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.

impl NsConsensusRouterStatus

pub fn rd_digest(&self) -> &RdDigest

Return the expected router descriptor digest for this routerstatus

Trait Implementations

impl Clone for NsConsensusRouterStatus

fn clone(&self) -> NsConsensusRouterStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NsConsensusRouterStatus

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

Formats the value using the given formatter.

impl ParseRouterStatus for NsConsensusRouterStatus

fn flavor() -> ConsensusFlavor

Return the networkstatus consensus flavor in which this routerstatus appears.

fn from_section( sec: &Section<'_, NetstatusKwd> ) -> Result<NsConsensusRouterStatus>

Parse this object from a Section object containing its elements.

impl RouterStatus for NsConsensusRouterStatus

fn rsa_identity(&self) -> &RsaIdentity

Return the expected microdescriptor digest for this routerstatus

type DocumentDigest = [u8; 20]

A digest of the document that’s identified by this RouterStatus.

fn doc_digest(&self) -> &RdDigest

Return the digest of the document identified by this routerstatus.