Struct MicrodescAndHash 

#[non_exhaustive]
pub struct MicrodescAndHash {
    pub md: Microdesc,
    pub sha256: MdDigest,
}

A single microdescriptor and also its SHA256 hash

API compatibility type.

This type is only generated when the microdescriptor is parsed using the old parser (MicrodescAndHash::parse) rather than the new one (Microdesc as NetdocParseable).

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.

md: Microdesc

The microdescriptor

sha256: MdDigest

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.

Implementations

impl MicrodescAndHash

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.

impl MicrodescAndHash

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

Parse a string into a new microdescriptor.

Methods from Deref<Target = Microdesc>

pub fn ntor_key(&self) -> &PublicKey

Return the ntor onion key for this microdesc

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

Return the ipv4 exit policy for this microdesc

pub fn ipv6_policy(&self) -> &Intern<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.

pub fn family_ids(&self) -> &[RelayFamilyId]

Return a list of family ids for this microdesc.

Trait Implementations

impl Clone for MicrodescAndHash

fn clone(&self) -> MicrodescAndHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MicrodescAndHash

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

Formats the value using the given formatter.

impl Deref for MicrodescAndHash

type Target = Microdesc

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for MicrodescAndHash

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Eq for MicrodescAndHash

impl PartialEq for MicrodescAndHash

fn eq(&self, other: &MicrodescAndHash) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MicrodescAndHash