Struct arti_client::config::TorClientConfig

#[non_exhaustive]
pub struct TorClientConfig { /* 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.

Implementations

impl TorClientConfig

pub fn builder() -> TorClientConfigBuilder

Returns a fresh, default, builder

impl TorClientConfig

pub fn fs_mistrust(&self) -> &Mistrust

Return a reference to the fs_mistrust::Mistrust object that we’ll use to check permissions on files and directories by default.

Usage notes

In the future, specific files or directories may have stricter or looser permissions checks applied to them than this default. Callers shouldn’t use this Mistrust to predict what Arti will accept for a specific file or directory. Rather, you should use this if you have some file or directory of your own on which you’d like to enforce the same rules as Arti uses.

Trait Implementations

impl AsRef<CircuitTiming> for TorClientConfig

fn as_ref(&self) -> &CircuitTiming

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<FallbackList> for TorClientConfig

fn as_ref(&self) -> &FallbackList

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PathConfig> for TorClientConfig

fn as_ref(&self) -> &PathConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<PreemptiveCircuitConfig> for TorClientConfig

fn as_ref(&self) -> &PreemptiveCircuitConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl CircMgrConfig for TorClientConfig

fn path_rules(&self) -> &PathConfig

Access the field

fn circuit_timing(&self) -> &CircuitTiming

Access the field

fn preemptive_circuits(&self) -> &PreemptiveCircuitConfig

Access the field

fn fallbacks(&self) -> &FallbackList

Access the field

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 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 TopLevel for TorClientConfig

type Builder = TorClientConfigBuilder

The Builder which can be used to make a Self

impl Eq for TorClientConfig

impl StructuralEq for TorClientConfig

impl StructuralPartialEq for TorClientConfig