Struct MicrodescriptorBuilder 

pub struct MicrodescriptorBuilder { /* private fields */ }

Builder for Microdescriptor.

Implementations

impl MicrodescriptorBuilder

pub fn onion_key<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

RSA onion key for TAP circuit handshake (PEM format).

This is the legacy key used for the original Tor handshake. Modern clients prefer the ntor handshake using ntor_onion_key.

pub fn ntor_onion_key<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

Curve25519 onion key for ntor circuit handshake (base64).

This is the modern key used for the ntor handshake, which provides better security properties than the TAP handshake.

pub fn or_addresses<VALUE: Into<Vec<(IpAddr, u16, bool)>>>( &mut self, value: VALUE, ) -> &mut Self

Additional addresses (IPv4 or IPv6) the relay listens on.

Each tuple is (address, port, is_ipv6). The a lines in the microdescriptor provide these additional addresses.

pub fn family<VALUE: Into<Vec<String>>>(&mut self, value: VALUE) -> &mut Self

Fingerprints of related relays (same operator).

These are typically prefixed with $ and contain the full 40-character hex fingerprint.

pub fn exit_policy<VALUE: Into<MicroExitPolicy>>( &mut self, value: VALUE, ) -> &mut Self

Compact IPv4 exit policy.

Unlike full exit policies, microdescriptor policies only specify which ports are accepted or rejected, not addresses.

pub fn exit_policy_v6<VALUE: Into<MicroExitPolicy>>( &mut self, value: VALUE, ) -> &mut Self

Compact IPv6 exit policy.

Separate policy for IPv6 traffic, if different from IPv4.

pub fn identifiers<VALUE: Into<HashMap<String, String>>>( &mut self, value: VALUE, ) -> &mut Self

Identity key digests by type.

Maps key type (e.g., “rsa1024”, “ed25519”) to the base64-encoded digest of that key.

pub fn protocols<VALUE: Into<HashMap<String, Vec<u32>>>>( &mut self, value: VALUE, ) -> &mut Self

Supported protocol versions.

Maps protocol name to list of supported versions. Common protocols include “Link”, “Relay”, “HSDir”, etc.

pub fn raw_content<VALUE: Into<Vec<u8>>>(&mut self, value: VALUE) -> &mut Self

Raw bytes of the original descriptor content.

pub fn annotations<VALUE: Into<Vec<(String, Option<String>)>>>( &mut self, value: VALUE, ) -> &mut Self

Annotations from CollecTor archives.

Each annotation is a (key, optional_value) pair from lines starting with @.

pub fn unrecognized_lines<VALUE: Into<Vec<String>>>( &mut self, value: VALUE, ) -> &mut Self

Lines that were not recognized during parsing.

pub fn build(&self) -> Result<Microdescriptor, MicrodescriptorBuilderError>

Builds a new Microdescriptor.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for MicrodescriptorBuilder

fn clone(&self) -> MicrodescriptorBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MicrodescriptorBuilder

fn default() -> Self

Returns the “default value” for a type.