Struct arti_client::config::TorClientConfigBuilder

pub struct TorClientConfigBuilder { /* private fields */ }

Builder for TorClientConfig.

Implementations

impl TorClientConfigBuilder

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

Information about the Tor network we want to connect to.

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

Directories for storing information on disk

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

Information about when and how often to download directory information

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.

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

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

pub fn bridges(&mut self) -> &mut BridgesConfigBuilder

Information about bridges, pluggable transports, and so on

pub fn channel(&mut self) -> &mut ChannelConfigBuilder

Information about how to build paths through the network.

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

Information about how to build paths through the network.

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

Information about preemptive circuits.

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

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

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

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

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

Information about timing out client requests.

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

Builds a new TorClientConfig.

Errors

If a required field has not been initialized.

impl TorClientConfigBuilder

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

impl Builder for TorClientConfigBuilder

type Built = TorClientConfig

The type that this builder constructs

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

Build into a Built

impl Clone for TorClientConfigBuilder

fn clone(&self) -> TorClientConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TorClientConfigBuilder

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

Formats the value using the given formatter.

impl Default for TorClientConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Serialize for TorClientConfigBuilder

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

Serialize this value into the given Serde serializer.