Struct arti_client::config::TorClientConfigBuilder

source · [−]

pub struct TorClientConfigBuilder { /* fields omitted */ }

Expand description

Builder object used to construct a TorClientConfig.

Unlike other builder types in Arti, this builder works by exposing an inner builder for each section in the TorClientConfig.

Implementations

source

impl TorClientConfigBuilder

source

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

Construct a TorClientConfig from this builder.

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.

source

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

Return a mutable reference to a NetworkConfigBuilder to use in configuring the underlying Tor network.

Most programs shouldn’t need to alter this configuration: it’s only for cases when you need to use a nonstandard set of Tor directory authorities and fallback caches.

source

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

Return a mutable reference to a StorageConfigBuilder.

This section is used to configure the locations where Arti should store files on disk.

source

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

Return a mutable reference to a DownloadScheduleConfigBuilder.

This section is used to override Arti’s schedule when attempting and retrying to download directory objects.

source

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

Return a mutable reference to a HashMap of network parameters that should be used to override those specified in the consensus directory.

This section should not usually be used for anything but testing: if you find yourself needing to configure an override here for production use, please consider opening a feature request for it instead.

For a complete list of Tor’s defined network parameters (not all of which are yet supported by Arti), see path-spec.txt.

source

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

Return a mutable reference to a PathConfigBuilder.

This section is used to override Arti’s rules for selecting which relays should be used in a given circuit.

source

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

Return a mutable reference to a PreemptiveCircuitConfigBuilder.

This section overrides Arti’s rules for preemptive circuits.

source

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

Return a mutable reference to a CircuitTimingBuilder.

This section overrides Arti’s rules for deciding how long to use circuits, and when to give up on attempts to launch them.

source

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

Return a mutable reference to a StreamTimeoutConfigBuilder.

This section overrides Arti’s rules for deciding how long a stream request (that is, an attempt to connect or resolve) should wait for a response before deciding that the stream has timed out.

source

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

Return a mutable reference to a ClientAddrConfigBuilder.

This section controls which addresses Arti is willing to launch connections to over the Tor network. Any addresses rejected by this section cause stream attempts to fail before any traffic is sent over the network.