Struct tor_netdoc::doc::netstatus::CommonHeader

#[non_exhaustive]
pub struct CommonHeader {
    pub flavor: ConsensusFlavor,
    pub lifetime: Lifetime,
    pub client_versions: Vec<String>,
    pub relay_versions: Vec<String>,
    pub client_protos: ProtoStatus,
    pub relay_protos: ProtoStatus,
    pub params: NetParams<i32>,
    pub voting_delay: Option<(u32, u32)>,
}

Parts of the networkstatus header that are present in every networkstatus.

NOTE: this type is separate from the header parts that are only in votes or only in consensuses, even though we don’t implement votes yet.

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.

flavor: ConsensusFlavor

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

What kind of consensus document is this? Absent in votes and in ns-flavored consensuses.

lifetime: Lifetime

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

Over what time is this consensus valid? (For votes, this is the time over which the voted-upon consensus should be valid.)

client_versions: Vec<String>

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

List of recommended Tor client versions.

relay_versions: Vec<String>

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

List of recommended Tor relay versions.

client_protos: ProtoStatus

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

Lists of recommended and required subprotocol versions for clients

relay_protos: ProtoStatus

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

Lists of recommended and required subprotocol versions for relays

params: NetParams<i32>

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

Declared parameters for tunable settings about how to the network should operator. Some of these adjust timeouts and whatnot; some features things on and off.

voting_delay: Option<(u32, u32)>

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

How long in seconds should voters wait for votes and signatures (respectively) to propagate?

Trait Implementations

impl Clone for CommonHeader

fn clone(&self) -> CommonHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommonHeader

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

Formats the value using the given formatter.