Struct RouterStatusBuilder

pub struct RouterStatusBuilder<D> { /* private fields */ }

Available on crate feature build_docs only.

A Builder object for creating a RouterStatus and adding it to a consensus.

Implementations

impl<D: Clone> RouterStatusBuilder<D>

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

Set the nickname for this routerstatus.

This value defaults to “Unnamed”.

pub fn identity(&mut self, identity: RsaIdentity) -> &mut Self

Set the RSA identity for this routerstatus.

(The Ed25519 identity is in the microdescriptor).

This value is required.

pub fn add_or_port(&mut self, addr: SocketAddr) -> &mut Self

Add an OrPort at addr to this routerstatus.

At least one value here is required.

pub fn doc_digest(&mut self, doc_digest: D) -> &mut Self

Set the document digest for this routerstatus.

This value is required.

pub fn set_flags(&mut self, flags: RelayFlags) -> &mut Self

Replace the current flags in this routerstatus with flags.

pub fn add_flags(&mut self, flags: RelayFlags) -> &mut Self

Make all the flags in flags become set on this routerstatus, in addition to the flags already set.

pub fn clear_flags(&mut self, flags: RelayFlags) -> &mut Self

Available on crate feature testing only.

Make all the flags in flags become cleared on this routerstatus.

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

Set the version of the relay described in this routerstatus.

This value is optional.

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

Set the list of subprotocols supported by the relay described by this routerstatus.

This value is required.

pub fn weight(&mut self, weight: RelayWeight) -> &mut Self

Set the weight of this routerstatus for random selection.

This value is optional; it defaults to 0.

impl RouterStatusBuilder<RdDigest>

pub fn build_into( &self, builder: &mut ConsensusBuilder<NsConsensusRouterStatus>, ) -> Result<()>

Available on crate feature ns_consensus only.

Try to finish this builder and add its RouterStatus to a provided ConsensusBuilder.

pub fn build(&self) -> Result<NsConsensusRouterStatus>

Available on crate feature ns_consensus only.

Return a router status built by this object.

impl RouterStatusBuilder<MdDigest>

pub fn build_into( &self, builder: &mut ConsensusBuilder<MdConsensusRouterStatus>, ) -> Result<()>

Try to finish this builder and add its RouterStatus to a provided ConsensusBuilder.x

pub fn build(&self) -> Result<MdConsensusRouterStatus>

Return a router status built by this object.

Trait Implementations

impl<D: Clone> Clone for RouterStatusBuilder<D>

fn clone(&self) -> RouterStatusBuilder<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for RouterStatusBuilder<D>

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

Formats the value using the given formatter.