Struct arti_client::config::TorClientConfigBuilder

source · [−]

pub struct TorClientConfigBuilder { /* private fields */ }

Expand description

Builder for TorClientConfig.

Implementations

source

impl TorClientConfigBuilder

source

pub fn tor_network(&mut self) -> &mut NetworkConfigBuilder

Information about the Tor network we want to connect to.

source

pub fn storage(&mut self) -> &mut StorageConfigBuilder

Directories for storing information on disk

source

pub fn download_schedule(&mut self) -> &mut DownloadScheduleConfigBuilder

Information about when and how often to download directory information

source

pub fn directory_tolerance(&mut self) -> &mut DirToleranceBuilder

Information about how premature or expired our directories are allowed to be.

These options help us tolerate clock skew, and help survive the case where the directory authorities are unable to reach consensus for a while.

source

pub fn override_net_params(&mut self) -> &mut HashMap<String, i32>

Facility to override network parameters from the values set in the consensus.

source

pub fn path_rules(&mut self) -> &mut PathConfigBuilder

Information about how to build paths through the network.

source

pub fn preemptive_circuits(&mut self) -> &mut PreemptiveCircuitConfigBuilder

Information about preemptive circuits.

source

pub fn circuit_timing(&mut self) -> &mut CircuitTimingBuilder

Information about how to retry and expire circuits and request for circuits.

source

pub fn address_filter(&mut self) -> &mut ClientAddrConfigBuilder

Rules about which addresses the client is willing to connect to.

source

pub fn stream_timeouts(&mut self) -> &mut StreamTimeoutConfigBuilder

Information about timing out client requests.

source

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

Builds a new TorClientConfig.

Errors

If a required field has not been initialized.

source

impl TorClientConfigBuilder

source

pub fn from_directories<P, Q>(state_dir: P, cache_dir: Q) -> Self where
P: AsRef<Path>,
Q: AsRef<Path>,

Returns a TorClientConfigBuilder using the specified state and cache directories.

All other configuration options are set to their defaults.

Trait Implementations

source

impl Builder for TorClientConfigBuilder

type Built = TorClientConfig

The type that this builder constructs

source

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

Build into a Built Read more

source

impl Clone for TorClientConfigBuilder

source

fn clone(&self) -> TorClientConfigBuilder

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 TorClientConfigBuilder

source

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

Formats the value using the given formatter. Read more

source

impl Default for TorClientConfigBuilder

source

fn default() -> Self

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

source

impl<'de> Deserialize<'de> for TorClientConfigBuilder

source

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

Deserialize this value from the given Serde deserializer. Read more

source

impl Serialize for TorClientConfigBuilder

source

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

impl RefUnwindSafe for TorClientConfigBuilder

impl Send for TorClientConfigBuilder

impl Sync for TorClientConfigBuilder

impl Unpin for TorClientConfigBuilder

impl UnwindSafe for TorClientConfigBuilder

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

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

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

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

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

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

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

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

source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

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 for T where
U: From<T>,

const: unstable · 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> Same<T> 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

source

Struct arti_client::config::TorClientConfigBuilder

Implementations

impl TorClientConfigBuilder

pub fn tor_network(&mut self) -> &mut NetworkConfigBuilder

pub fn storage(&mut self) -> &mut StorageConfigBuilder

pub fn download_schedule(&mut self) -> &mut DownloadScheduleConfigBuilder

pub fn directory_tolerance(&mut self) -> &mut DirToleranceBuilder

pub fn override_net_params(&mut self) -> &mut HashMap<String, i32>

pub fn path_rules(&mut self) -> &mut PathConfigBuilder

pub fn preemptive_circuits(&mut self) -> &mut PreemptiveCircuitConfigBuilder

pub fn circuit_timing(&mut self) -> &mut CircuitTimingBuilder

pub fn address_filter(&mut self) -> &mut ClientAddrConfigBuilder

pub fn stream_timeouts(&mut self) -> &mut StreamTimeoutConfigBuilder

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

Errors

impl TorClientConfigBuilder

pub fn from_directories<P, Q>(state_dir: P, cache_dir: Q) -> Self where P: AsRef<Path>, Q: AsRef<Path>,

Trait Implementations

impl Builder for TorClientConfigBuilder

type Built = TorClientConfig

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

impl Clone for TorClientConfigBuilder

fn clone(&self) -> TorClientConfigBuilder

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

impl Debug for TorClientConfigBuilder

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

impl Default for TorClientConfigBuilder

fn default() -> Self

impl<'de> Deserialize<'de> for TorClientConfigBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl Serialize for TorClientConfigBuilder

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer,

Auto Trait Implementations

impl RefUnwindSafe for TorClientConfigBuilder

impl Send for TorClientConfigBuilder

impl Sync for TorClientConfigBuilder

impl Unpin for TorClientConfigBuilder

impl UnwindSafe for TorClientConfigBuilder

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

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

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

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

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

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

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

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

pub fn from_directories<P, Q>(state_dir: P, cache_dir: Q) -> Self where
P: AsRef<Path>,
Q: AsRef<Path>,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,