Struct tor_netdoc::doc::netstatus::Consensus

#[non_exhaustive]
pub struct Consensus<RS> {
    pub header: ConsensusHeader,
    pub voters: Vec<ConsensusVoterInfo>,
    pub relays: Vec<RS>,
    pub footer: Footer,
}

A single microdescriptor consensus netstatus

TODO: This should possibly turn into a parameterized type, to represent votes and ns consensuses.

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.

header: ConsensusHeader

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

Part of the header shared by all consensus types.

voters: Vec<ConsensusVoterInfo>

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

List of voters whose votes contributed to this consensus.

relays: Vec<RS>

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

A list of routerstatus entries for the relays on the network, with one entry per relay.

footer: Footer

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

Footer for the consensus object.

Implementations

impl<RS> Consensus<RS>

pub fn lifetime(&self) -> &Lifetime

Return the Lifetime for this consensus.

pub fn relays(&self) -> &[RS]

Return a slice of all the routerstatus entries in this consensus.

pub fn bandwidth_weights(&self) -> &NetParams<i32>

Return a mapping from keywords to integers representing how to weight different kinds of relays in different path positions.

pub fn params(&self) -> &NetParams<i32>

Return the map of network parameters that this consensus advertises.

pub fn shared_rand_cur(&self) -> Option<&SharedRandStatus>

Return the latest shared random value, if the consensus contains one.

pub fn shared_rand_prev(&self) -> Option<&SharedRandStatus>

Return the previous shared random value, if the consensus contains one.

impl<RS: RouterStatus + ParseRouterStatus> Consensus<RS>

pub fn builder() -> ConsensusBuilder<RS>

Available on crate feature build_docs only.

Return a new ConsensusBuilder for building test consensus objects.

This function is only available when the build_docs feature has been enabled.

pub fn parse(s: &str) -> Result<(&str, &str, UncheckedConsensus<RS>)>

Try to parse a single networkstatus document from a string.

Trait Implementations

impl<RS: Clone> Clone for Consensus<RS>

fn clone(&self) -> Consensus<RS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<RS: Debug> Debug for Consensus<RS>

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

Formats the value using the given formatter.

impl<RS> ExternallySigned<Consensus<RS>> for UnvalidatedConsensus<RS>

type Key = [AuthCert]

The type of the public key object.

type KeyHint = Vec<AuthCertKeyIds, Global>

A type that describes what keys are missing for this object.

type Error = Error

An error type that’s returned when the object is not well-signed.

fn key_is_correct(&self, k: &Self::Key) -> Result<(), Self::KeyHint>

Check whether k is the right key for this object. If not, return an error describing what key would be right.

fn is_well_signed(&self, k: &Self::Key) -> Result<(), Self::Error>

Check the signature on this object

fn dangerously_assume_wellsigned(self) -> Consensus<RS>

Unwrap this object without checking any signatures on it.

fn check_signature(self, k: &Self::Key) -> Result<T, Self::Error>

Unwrap this object if it’s correctly signed by a provided key.