tor_netdoc::doc::microdesc

Struct 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,
    pub family_ids: Vec<RelayFamilyId>,
}

Expand description

A single microdescriptor.

Fields (Non-exhaustive)§

This struct is marked as 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

§family_ids: Vec<RelayFamilyId>

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

Family identities 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.

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

Return a list of family ids for this microdesc.

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. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Microdesc

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Microdesc

impl RefUnwindSafe for Microdesc

impl Send for Microdesc

impl Sync for Microdesc

impl Unpin for Microdesc

impl UnwindSafe for Microdesc

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> Downcast for T
where T: Any,

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

impl<T> DowncastSend for T
where T: Any + Send,

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

impl<T> DowncastSync for T
where T: Any + Send + Sync,

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Sync + Send>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T