Struct tor_netdoc::doc::microdesc::Microdesc

#[non_exhaustive]
pub struct Microdesc {
    pub sha256: MdDigest,
    pub ntor_onion_key: PublicKey,
    pub family: Arc<RelayFamily>,
    pub ipv4_policy: Arc<PortPolicy>,
    pub ipv6_policy: Arc<PortPolicy>,
    pub ed25519_id: Ed25519Identity,
}

A single microdescriptor.

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.

sha256: MdDigest

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

The SHA256 digest of the text of this microdescriptor. This value is used to identify the microdescriptor when downloading it, and when listing it in a consensus document.

ntor_onion_key: PublicKey

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

Public key used for the ntor circuit extension protocol.

family: Arc<RelayFamily>

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

Declared family for this relay.

ipv4_policy: Arc<PortPolicy>

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

List of IPv4 ports to which this relay will exit

ipv6_policy: Arc<PortPolicy>

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

List of IPv6 ports to which this relay will exit

ed25519_id: Ed25519Identity

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

Ed25519 identity for this relay

Implementations

impl Microdesc

pub fn builder() -> MicrodescBuilder

Available on crate feature build_docs only.

Create a new MicrodescBuilder that can be used to construct microdescriptors.

This function is only available when the crate is built with the build_docs feature.

Limitations

The generated microdescriptors cannot yet be encoded, and do not yet have correct sha256 digests. As such they are only useful for testing.

pub fn digest(&self) -> &MdDigest

Return the sha256 digest of this microdesc.

pub fn ntor_key(&self) -> &PublicKey

Return the ntor onion key for this microdesc

pub fn ipv4_policy(&self) -> &Arc<PortPolicy>

Return the ipv4 exit policy for this microdesc

pub fn ipv6_policy(&self) -> &Arc<PortPolicy>

Return the ipv6 exit policy for this microdesc

pub fn family(&self) -> &RelayFamily

Return the relay family for this microdesc

pub fn ed25519_id(&self) -> &Ed25519Identity

Return the ed25519 identity for this microdesc, if its Ed25519 identity is well-formed.

impl Microdesc

pub fn parse(s: &str) -> Result<Microdesc>

Parse a string into a new microdescriptor.

Trait Implementations

impl Clone for Microdesc

fn clone(&self) -> Microdesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Microdesc

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

Formats the value using the given formatter.