Module config

Source
Expand description

Types and functions to configure a Tor client.

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

Re-exportsยง

pub use tor_config::mistrust::BuilderExt as _;

Modulesยง

circ
Types for configuring how Tor circuits are built.
dir
Types for configuring how Tor accesses its directory information.
onion_serviceonion-service-service
Types for configuring onion services.
ptpt-client
Types for configuring pluggable transports.
vanguards
Types for configuring vanguards.

Macrosยง

convert_helper_via_multi_line_list_builder
Implement TryFrom<MultilineListBuilder> and Into<MultilineListBuilder> for $Builder.
define_list_builder_accessors
Define accessor methods for a configuration item which is a list
define_list_builder_helper
Define a list builder struct for use with define_list_builder_accessors
expand_dir ๐Ÿ”’
Macro to avoid repeating code for expand_*_dir functions on StorageConfig
impl_standard_builder
Defines standard impls for a struct with a Builder, incl Default

Structsยง

BridgeConfigBuilder
Builder for a BridgeConfig.
BridgeListBuilder ๐Ÿ”’
Wrapper struct to help derive_builder find the right types and methods
BridgesConfig
Configuration for anti-censorship features: bridges and pluggable transports.
BridgesConfigBuilder
Builder for BridgesConfig.
CfgPath
A path in a configuration file: tilde expansion is performed, along with expansion of variables provided by a CfgPathResolver.
CfgPathResolver
A variable resolver for paths in a configuration file.
ChannelConfig
Channel configuration
ChannelConfigBuilder
Builder for ChannelConfig.
ClientAddrConfig
Configuration for client behavior relating to addresses.
ClientAddrConfigBuilder
Builder for ClientAddrConfig.
MultilineListBuilderError
Error from trying to parse a MultilineListBuilder as a list of particular items
PtTransportName
The name of a Pluggable Transport protocol.
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.
SystemConfig
Configuration for system resources used by Tor.
SystemConfigBuilder
Builder for SystemConfig.
TorClientConfig
A configuration used to bootstrap a TorClient.
TorClientConfigBuilder
Builder for TorClientConfig.
TransportConfigListBuilder
Wrapper struct to help derive_builder find the right types and methods
TransportId
Identify a type of Transport.

Enumsยง

BoolOrAuto
Boolean, but with additional "auto" option
BridgeParseErrorbridge-client
Error when parsing a bridge line from a string
CfgPathError
An error that has occurred while expanding a path.
ChannelMethod
The way to approach a single relay in order to open a channel.
ConfigBuildError
An error related to an option passed to Arti via a configuration builder.
ConfigError
An error that occurs while trying to read and process our configuration.
ConfigurationSource
A configuration file or directory, for use by a ConfigurationSources
MultilineListBuilder
Configuration item specifiable as a list, or a single multi-line string
Reconfigure
Rules for reconfiguring a running Arti instance.

Constantsยง

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

Traitsยง

HasChanMethod
An object that can be connected to via ChannelMethods.

Functionsยง

bridges_enabled ๐Ÿ”’
Generic logic to check if bridges should be used or not
default_cache_dir ๐Ÿ”’
Return the default cache directory.
default_config_files
Return the filenames for the default user configuration files
default_connect_timeout ๐Ÿ”’
Return the default stream timeout
default_dns_resolve_ptr_timeout ๐Ÿ”’
Return the default PTR resolve timeout
default_dns_resolve_timeout ๐Ÿ”’
Return the default resolve timeout
default_extend ๐Ÿ”’
Helper to add overrides to a default collection.
default_state_dir ๐Ÿ”’
Return the default state directory.
fs_permissions_checks_disabled_via_envDeprecated
Return true if the environment has been set up to disable FS permissions checking.
validate_bridges_config ๐Ÿ”’
Check that the bridge configuration is right
validate_pt_config ๐Ÿ”’ pt-client
Determine if we need any pluggable transports.

Type Aliasesยง

BridgeList
List of configured bridges, as found in the built configuration
TransportConfigList ๐Ÿ”’ pt-client
A list of configured transport binaries (type alias for macrology).