Struct arti_client::config::circ::PathConfigBuilder

source · [−]

pub struct PathConfigBuilder { /* private fields */ }

Expand description

Builder for PathConfig.

Implementations

source

impl PathConfigBuilder

source

pub fn ipv4_subnet_family_prefix(&mut self, value: u8) -> &mut PathConfigBuilder

Set the length of a bit-prefix for a default IPv4 subnet-family.

Any two relays will be considered to belong to the same family if their IPv4 addresses share at least this many initial bits.

source

pub fn ipv6_subnet_family_prefix(&mut self, value: u8) -> &mut PathConfigBuilder

Set the length of a bit-prefix for a default IPv6 subnet-family.

Any two relays will be considered to belong to the same family if their IPv6 addresses share at least this many initial bits.

source

pub fn build(&self) -> Result<PathConfig, ConfigBuildError>

Builds a new PathConfig.

Errors

If a required field has not been initialized.

source

impl PathConfigBuilder

source

pub fn reachable_addrs(&mut self) -> &mut Vec<AddrPortPattern, Global>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

The set of addresses to which we’re willing to make direct connections (accessor).

Mutable accessor

This method access the being-built list reachable_addrs (resolving the default first).

If the field has not yet been set or accessed, the default list will be constructed and a mutable reference to the now-defaulted list of builders will be returned.

source

pub fn set_reachable_addrs(&mut self, list: Vec<AddrPortPattern, Global>)

The set of addresses to which we’re willing to make direct connections (setter).

Setter

This method replaces the whole being-built list reachable_addrs.

This overrides the default, and also overrides any previous settings.

source

pub fn opt_reachable_addrs(&self) -> &Option<Vec<AddrPortPattern, Global>>

The set of addresses to which we’re willing to make direct connections (inspector, Option).

Inspector (default-aware, involving `Option`)

This method inspects the being-built list reachable_addrs (with default unresolved).

If the list has not yet been set, or accessed, &None is returned.

source

pub fn opt_reachable_addrs_mut(
&mut self
) -> &mut Option<Vec<AddrPortPattern, Global>>

The set of addresses to which we’re willing to make direct connections (accessor, Option).

Mutable accessor (default-aware, involving `Option`)

This method mutably accesses the being-built list reachable_addrs (with default unresolved).

None represents the use of the default value: If the list has not yet been set, or accessed, &mut None is returned. Assigning None will undo any previous settings and arrange for the default value to be used when the field value is resolved,

Trait Implementations

source

impl Builder for PathConfigBuilder

type Built = PathConfig

The type that this builder constructs

source

fn build(&self) -> Result<PathConfig, ConfigBuildError>

Build into a Built Read more

source

impl Clone for PathConfigBuilder

source

fn clone(&self) -> PathConfigBuilder

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 PathConfigBuilder

source

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

Formats the value using the given formatter. Read more

source

impl Default for PathConfigBuilder

source

fn default() -> PathConfigBuilder

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for PathConfigBuilder

source

fn deserialize<D>(
deserializer: D
) -> Result<PathConfigBuilder, <D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Serialize for PathConfigBuilder

source

fn serialize<S>(
 &self,
 serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
 S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for PathConfigBuilder

impl Send for PathConfigBuilder

impl Sync for PathConfigBuilder

impl Unpin for PathConfigBuilder

impl UnwindSafe for PathConfigBuilder

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

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

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

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

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

source

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

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

source

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

source

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

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more