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_
service onion-service-service - Types for configuring onion services.
- pt
pt-client - Types for configuring pluggable transports.
- vanguards
- Types for configuring vanguards.
Macros§
- convert_
helper_ via_ multi_ line_ list_ builder - Implement
TryFrom<MultilineListBuilder>andInto<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_*_dirfunctions on StorageConfig - impl_
standard_ builder - Defines standard impls for a struct with a
Builder, inclDefault
Structs§
- Bridge
Config Builder - Builder for a
BridgeConfig. - Bridge
List 🔒Builder - Wrapper struct to help derive_builder find the right types and methods
- Bridges
Config - Configuration for anti-censorship features: bridges and pluggable transports.
- Bridges
Config Builder - Builder for
BridgesConfig. - CfgPath
- A path in a configuration file: tilde expansion is performed, along
with expansion of variables provided by a
CfgPathResolver. - CfgPath
Resolver - A variable resolver for paths in a configuration file.
- Channel
Config - Channel configuration
- Channel
Config Builder - Builder for
ChannelConfig. - Client
Addr Config - Configuration for client behavior relating to addresses.
- Client
Addr Config Builder - Builder for
ClientAddrConfig. - Configuration
Sources - A description of where to find our configuration options.
- Multiline
List Builder Error - Error from trying to parse a MultilineListBuilder as a list of particular items
- PtTransport
Name - The name of a Pluggable Transport protocol.
- Software
Status Override Config - Configuration for overriding the status of our software.
- Software
Status Override Config Builder - Builder for
SoftwareStatusOverrideConfig. - Storage
Config - Configuration for where information should be stored on disk.
- Storage
Config Builder - Builder for
StorageConfig. - Stream
Timeout Config - Configuration for client behavior relating to stream connection timeouts
- Stream
Timeout Config Builder - Builder for
StreamTimeoutConfig. - System
Config - Configuration for system resources used by Tor.
- System
Config Builder - Builder for
SystemConfig. - TorClient
Config - A configuration used to bootstrap a
TorClient. - TorClient
Config Builder - Builder for
TorClientConfig. - Transport
Config List Builder - Wrapper struct to help derive_builder find the right types and methods
- Transport
Id - Identify a type of Transport.
Enums§
- Bool
OrAuto - Boolean, but with additional
"auto"option - Bridge
Parse Error bridge-client - Error when parsing a bridge line from a string
- CfgPath
Error - An error that has occurred while expanding a path.
- Channel
Method - The way to approach a single relay in order to open a channel.
- Config
Build Error - An error related to an option passed to Arti via a configuration builder.
- Config
Error - An error that occurs while trying to read and process our configuration.
- Configuration
Source - A configuration file or directory, for use by a
ConfigurationSources - Multiline
List Builder - 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_ VAR Deprecated - The environment variable we look at when deciding whether to disable FS permissions checking.
Traits§
- HasChan
Method - 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_ env Deprecated - 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§
- Bridge
List - List of configured bridges, as found in the built configuration
- Transport
Config 🔒List pt-client - A list of configured transport binaries (type alias for macrology).