Struct RouterStatus 

#[non_exhaustive]
pub struct RouterStatus {
    pub r: RouterStatusIntroItem,
    pub m: MdDigest,
    pub a: Vec<SocketAddr>,
    pub flags: RelayFlags,
    pub version: Option<Version>,
    pub protos: Arc<Protocols>,
    pub weight: RelayWeight,
}

A single relay’s status, in a network status document.

https://spec.torproject.org/dir-spec/consensus-formats.html#section:router-status

https://spec.torproject.org/dir-spec/computing-consensus.html#flavor:microdesc under “Changes to router status entries”.

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.

r: RouterStatusIntroItem

r — Introduce a routerstatus entry

https://spec.torproject.org/dir-spec/consensus-formats.html#item:r (and, the the md version, which is different).

m: MdDigest

m — Microdescriptor or document digest

In an md consensus, the hash of the document for this relay. In a vote, microdescriptor hashes for the various consensus methods.

https://spec.torproject.org/dir-spec/computing-consensus.html#flavor:microdesc r item.

a: Vec<SocketAddr>

a — Further router address(es) (IPv6)

https://spec.torproject.org/dir-spec/consensus-formats.html#item:a (and, the the md version, which is different).

flags: RelayFlags

s — Router status flags

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

version: Option<Version>

v — Relay’s Tor software version

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

protos: Arc<Protocols>

pr — Subprotocol capabilities supported

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

weight: RelayWeight

w — Bandwidth estimates

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

Implementations

impl RouterStatus

pub fn doc_digest(&self) -> &DocDigest

Return the digest of the document identified by this routerstatus.

The doc_digest method is provided on all varieties of routerstatus entry to help paper over the protocol anomaly, that the digest is in a different place in md routerstatus entries.

impl RouterStatus

pub fn 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 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.

impl RouterStatus

pub fn rsa_identity(&self) -> &RsaIdentity

Return RSA identity for the relay described by this RouterStatus

impl RouterStatus

pub fn md_digest(&self) -> &DocDigest

Return the expected microdescriptor digest for this routerstatus

Trait Implementations

impl Clone for RouterStatus

fn clone(&self) -> RouterStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouterStatus

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

Formats the value using the given formatter.

impl NetdocParseable for RouterStatus

fn doctype_for_error() -> &'static str

Available on crate feature parse2 only.

Document type for errors, normally its intro keyword

fn is_intro_item_keyword(kw: KeywordRef<'_>) -> bool

Available on crate feature parse2 only.

Is Keyword an intro Item Keyword for this kind of document?

fn from_items<'s>( input: &mut ItemStream<'s>, outer_stop: StopAt<impl StopPredicate>, ) -> Result<RouterStatus, ErrorProblem>

Available on crate feature parse2 only.

Parse the document from a stream of Items