Struct MicrodescBuilder

pub struct MicrodescBuilder {
    ntor_onion_key: Option<PublicKey>,
    family: RelayFamily,
    family_ids: Vec<RelayFamilyId>,
    ipv4_policy: PortPolicy,
    ipv6_policy: PortPolicy,
    ed25519_id: Option<Ed25519Identity>,
}

Available on crate feature build_docs only.

A builder object used to construct a microdescriptor.

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

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

Fields

ntor_onion_key: Option<PublicKey>

The ntor onion key we’ll be using.

See Microdesc::ntor_onion_key.

family: RelayFamily

The relay family we’ll be using.

See Microdesc::family.

family_ids: Vec<RelayFamilyId>

See Microdesc::family_ids

ipv4_policy: PortPolicy

See Microdesc::ipv4_policy

ipv6_policy: PortPolicy

See Microdesc::ipv6_policy

ed25519_id: Option<Ed25519Identity>

See Microdesc::ed25519_id

Implementations

impl MicrodescBuilder

pub(crate) fn new() -> Self

Create a new MicrodescBuilder.

pub fn ntor_key(&mut self, key: PublicKey) -> &mut Self

Set the ntor onion key.

This key is required for a well-formed microdescriptor.

pub fn ed25519_id(&mut self, key: Ed25519Identity) -> &mut Self

Set the ed25519 identity key.

This key is required for a well-formed microdescriptor.

pub fn family(&mut self, family: RelayFamily) -> &mut Self

Set the family of this relay.

By default, this family is empty.

pub fn add_family_id(&mut self, id: RelayFamilyId) -> &mut Self

Add id as a family ID for this relay.

pub fn ipv4_policy(&mut self, policy: PortPolicy) -> &mut Self

Set the ipv4 exit policy of this relay.

By default, this policy is reject 1-65535.

pub fn ipv6_policy(&mut self, policy: PortPolicy) -> &mut Self

Set the ipv6 exit policy of this relay.

By default, this policy is reject 1-65535.

pub fn parse_family(&mut self, family: &str) -> Result<&mut Self>

Set the family of this relay based on parsing a string.

pub fn parse_ipv4_policy(&mut self, policy: &str) -> Result<&mut Self>

Set the ipv4 exit policy of this relay based on parsing a string.

By default, this policy is reject 1-65535.

pub fn parse_ipv6_policy(&mut self, policy: &str) -> Result<&mut Self>

Set the ipv6 exit policy of this relay based on parsing a string.

By default, this policy is reject 1-65535.

pub fn testing_md(&self) -> Result<Microdesc>

Try to build a microdescriptor from the settings on this builder.

Give an error if any required fields are not set.

Limitations

This is only for testing, since it does actually encode the information in a string, and since it sets the sha256 digest field at random.

In the future, when we have authority support, we’ll need an encoder function instead.

Trait Implementations

impl Clone for MicrodescBuilder

fn clone(&self) -> MicrodescBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MicrodescBuilder

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

Formats the value using the given formatter.