Struct arti_client::config::TorClientConfig

pub struct TorClientConfig {
    pub system: SystemConfig,
    /* private fields */
}

A configuration used to bootstrap a TorClient.

In order to connect to the Tor network, Arti needs to know a few well-known directory caches on the network, and the public keys of the network’s directory authorities. It also needs a place on disk to store persistent state and cached directory information. (See StorageConfig for default directories.)

Most users will create a TorClientConfig by running TorClientConfig::default.

If you need to override the locations where Arti stores its information, you can make a TorClientConfig with TorClientConfigBuilder::from_directories.

Finally, you can get fine-grained control over the members of a a TorClientConfig using TorClientConfigBuilder.

⚠ Stability Warning ⚠

The design of this structure, and of the configuration system for Arti, is likely to change significantly before the release of Arti 1.0.0. The layout of options within this structure is also likely to change. For more information see ticket #285.

Fields

system: SystemConfig

Information about system resources

Implementations

impl TorClientConfig

pub fn builder() -> TorClientConfigBuilder

Return a new TorClientConfigBuilder.

Trait Implementations

impl Clone for TorClientConfig

fn clone(&self) -> TorClientConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TorClientConfig

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

Formats the value using the given formatter.

impl Default for TorClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<TorClientConfig> for TorClientConfigBuilder

fn from(cfg: TorClientConfig) -> TorClientConfigBuilder

Performs the conversion.

impl PartialEq<TorClientConfig> for TorClientConfig

fn eq(&self, other: &TorClientConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TorClientConfig) -> bool

This method tests for !=.

impl Eq for TorClientConfig

impl StructuralEq for TorClientConfig

impl StructuralPartialEq for TorClientConfig