Struct arti_client::config::TorClientConfigBuilder
source · pub struct TorClientConfigBuilder { /* private fields */ }
Expand description
Builder for TorClientConfig
.
Implementations§
source§impl TorClientConfigBuilder
impl TorClientConfigBuilder
sourcepub fn tor_network(&mut self) -> &mut NetworkConfigBuilder
pub fn tor_network(&mut self) -> &mut NetworkConfigBuilder
Information about the Tor network we want to connect to.
sourcepub fn storage(&mut self) -> &mut StorageConfigBuilder
pub fn storage(&mut self) -> &mut StorageConfigBuilder
Directories for storing information on disk
sourcepub fn download_schedule(&mut self) -> &mut DownloadScheduleConfigBuilder
pub fn download_schedule(&mut self) -> &mut DownloadScheduleConfigBuilder
Information about when and how often to download directory information
sourcepub fn directory_tolerance(&mut self) -> &mut DirToleranceBuilder
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.
sourcepub fn override_net_params(&mut self) -> &mut HashMap<String, i32>
pub fn override_net_params(&mut self) -> &mut HashMap<String, i32>
Facility to override network parameters from the values set in the consensus.
sourcepub fn bridges(&mut self) -> &mut BridgesConfigBuilder
pub fn bridges(&mut self) -> &mut BridgesConfigBuilder
Information about bridges, pluggable transports, and so on
sourcepub fn channel(&mut self) -> &mut ChannelConfigBuilder
pub fn channel(&mut self) -> &mut ChannelConfigBuilder
Information about how to build paths through the network.
sourcepub fn path_rules(&mut self) -> &mut PathConfigBuilder
pub fn path_rules(&mut self) -> &mut PathConfigBuilder
Information about how to build paths through the network.
sourcepub fn preemptive_circuits(&mut self) -> &mut PreemptiveCircuitConfigBuilder
pub fn preemptive_circuits(&mut self) -> &mut PreemptiveCircuitConfigBuilder
Information about preemptive circuits.
sourcepub fn circuit_timing(&mut self) -> &mut CircuitTimingBuilder
pub fn circuit_timing(&mut self) -> &mut CircuitTimingBuilder
Information about how to retry and expire circuits and request for circuits.
sourcepub fn address_filter(&mut self) -> &mut ClientAddrConfigBuilder
pub fn address_filter(&mut self) -> &mut ClientAddrConfigBuilder
Rules about which addresses the client is willing to connect to.
sourcepub fn stream_timeouts(&mut self) -> &mut StreamTimeoutConfigBuilder
pub fn stream_timeouts(&mut self) -> &mut StreamTimeoutConfigBuilder
Information about timing out client requests.
sourcepub fn build(&self) -> Result<TorClientConfig, ConfigBuildError>
pub fn build(&self) -> Result<TorClientConfig, ConfigBuildError>
source§impl TorClientConfigBuilder
impl TorClientConfigBuilder
sourcepub fn from_directories<P, Q>(state_dir: P, cache_dir: Q) -> Selfwhere
P: AsRef<Path>,
Q: AsRef<Path>,
pub fn from_directories<P, Q>(state_dir: P, cache_dir: Q) -> Selfwhere 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, except storage.keystore.path
,
which is derived from the specified state directory.
Trait Implementations§
source§impl Builder for TorClientConfigBuilder
impl Builder for TorClientConfigBuilder
§type Built = TorClientConfig
type Built = TorClientConfig
source§fn build(&self) -> Result<TorClientConfig, ConfigBuildError>
fn build(&self) -> Result<TorClientConfig, ConfigBuildError>
Built
Read moresource§impl Clone for TorClientConfigBuilder
impl Clone for TorClientConfigBuilder
source§fn clone(&self) -> TorClientConfigBuilder
fn clone(&self) -> TorClientConfigBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for TorClientConfigBuilder
impl Debug for TorClientConfigBuilder
source§impl Default for TorClientConfigBuilder
impl Default for TorClientConfigBuilder
source§impl<'de> Deserialize<'de> for TorClientConfigBuilder
impl<'de> Deserialize<'de> for TorClientConfigBuilder
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
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
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.