Struct tor_netdoc::doc::microdesc::MicrodescBuilder

source ·
pub struct MicrodescBuilder { /* private fields */ }
Available on crate feature build_docs only.
Expand description

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.

Implementations§

source§

impl MicrodescBuilder

source

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

Set the ntor onion key.

This key is required for a well-formed microdescriptor.

source

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

Set the ed25519 identity key.

This key is required for a well-formed microdescriptor.

source

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

Set the family of this relay.

By default, this family is empty.

source

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.

source

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.

source

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

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

source

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.

source

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.

source

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§

source§

impl Clone for MicrodescBuilder

source§

fn clone(&self) -> MicrodescBuilder

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
source§

impl Debug for MicrodescBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

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
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

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
source§

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
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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