Module arti_client::config

Types and functions to configure a Tor client.

Some of these are re-exported from lower-level crates.

⚠ 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.

Modules

circ

Types for configuring how Tor circuits are built.

dir

Types for configuring how Tor accesses its directory information.

Macros

impl_standard_builder

Defines standard impls for a struct with a Builder, incl Default

Structs

CfgPath

A path in a configuration file: tilde expansion is performed, along with expansion of certain variables.

ClientAddrConfig

Configuration for client behavior relating to addresses.

ClientAddrConfigBuilder

Builder for ClientAddrConfig.

StorageConfig

Configuration for where information should be stored on disk.

StorageConfigBuilder

Builder for StorageConfig.

StreamTimeoutConfig

Configuration for client behavior relating to stream connection timeouts

StreamTimeoutConfigBuilder

Builder for StreamTimeoutConfig.

TorClientConfig

A configuration used to bootstrap a TorClient.

TorClientConfigBuilder

Builder for TorClientConfig.

Enums

CfgPathError

An error that has occurred while expanding a path.

ConfigBuildError

An error related to an option passed to Arti via a configuration builder.

Reconfigure

Rules for reconfiguring a running Arti instance.

Constants

FS_PERMISSIONS_CHECKS_DISABLE_VAR

The environment variable we look at when deciding whether to disable FS permissions checking.

Functions

default_config_file

Return a filename for the default user configuration file.

fs_permissions_checks_disabled_via_envDeprecated

Return true if the environment has been set up to disable FS permissions checking.