Struct tor_netdoc::doc::netstatus::ConsensusBuilder

pub struct ConsensusBuilder<RS> { /* private fields */ }

A builder object used to construct a consensus.

Create one of these with the Consensus::builder method.

This facility is only enabled when the crate is built with the build_docs feature.

Implementations

impl<RS> ConsensusBuilder<RS>

pub fn lifetime(&mut self, lifetime: Lifetime) -> &mut Self

Set the lifetime of this consensus.

This value is required.

pub fn add_client_version(&mut self, ver: String) -> &mut Self

Add a single recommended Tor client version to this consensus.

These values are optional for testing.

pub fn add_relay_version(&mut self, ver: String) -> &mut Self

Add a single recommended Tor relay version to this consensus.

These values are optional for testing.

pub fn required_client_protos(&mut self, protos: Protocols) -> &mut Self

Set the required client protocol versions for this consensus.

This value defaults to “no protocol versions required.”

pub fn recommended_client_protos(&mut self, protos: Protocols) -> &mut Self

Set the recommended client protocol versions for this consensus.

This value defaults to “no protocol versions recommended.”

pub fn required_relay_protos(&mut self, protos: Protocols) -> &mut Self

Set the required relay protocol versions for this consensus.

This value defaults to “no protocol versions required.”

pub fn recommended_relay_protos(&mut self, protos: Protocols) -> &mut Self

Set the recommended client protocol versions for this consensus.

This value defaults to “no protocol versions recommended.”

pub fn param<S>(&mut self, param: S, val: i32) -> &mut Self where
    S: Into<String>, 

Set the value for a given consensus parameter by name.

pub fn voting_delay(
    &mut self,
    vote_delay: u32,
    signature_delay: u32
) -> &mut Self

Set the voting delays (in seconds) for this consensus.

pub fn consensus_method(&mut self, consensus_method: u32) -> &mut Self

Set the declared consensus method for this consensus.

This value is required.

pub fn shared_rand_prev(&mut self, n_reveals: u8, value: Vec<u8>) -> &mut Self

Set the previous day’s shared-random value for this consensus.

This value is optional.

pub fn shared_rand_cur(&mut self, n_reveals: u8, value: Vec<u8>) -> &mut Self

Set the current day’s shared-random value for this consensus.

This value is optional.

pub fn weight<S>(&mut self, param: S, val: i32) -> &mut Self where
    S: Into<String>, 

Set a named weight parameter for this consensus.

pub fn weights(&mut self, weights: NetParams<i32>) -> &mut Self

Replace all weight parameters for this consensus.

pub fn voter(&self) -> VoterInfoBuilder

Create a VoterInfoBuilder to add a voter to this builder.

In theory these are required, but nothing asks for them.

impl<RS: RouterStatus + Clone> ConsensusBuilder<RS>

pub fn rs(&self) -> RouterStatusBuilder<RS::DocumentDigest>

Create a RouterStatusBuilder to add a RouterStatus to this builder.

You can make a consensus with no RouterStatus entries, but it won’t actually be good for anything.

pub fn testing_consensus(&self) -> Result<Consensus<RS>>

Try to create a consensus object from this builder.

This object might not have all of the data that a valid consensus would have. Therefore, it should only be used for testing.