Module arti_client::config
source · Expand description
Types and functions to configure a Tor client.
Some of these are re-exported from lower-level crates.
Modules§
- Types for configuring how Tor circuits are built.
- 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
vanguards
and (onion-service-client
oronion-service-service
)Types for configuring vanguards.
Macros§
- Implement
TryFrom<MultilineListBuilder>
andInto<MultilineListBuilder>
for $Builder. - Define accessor methods for a configuration item which is a list
- Define a list builder struct for use with
define_list_builder_accessors
- Macro to avoid repeating code for
expand_*_dir
functions on StorageConfig - Defines standard impls for a struct with a
Builder
, inclDefault
Structs§
- Builder for a
BridgeConfig
. - Wrapper struct to help derive_builder find the right types and methods
- Configuration for anti-censorship features: bridges and pluggable transports.
- Builder for
BridgesConfig
. - A path in a configuration file: tilde expansion is performed, along with expansion of certain variables.
- Channel configuration
- Builder for
ChannelConfig
. - Configuration for client behavior relating to addresses.
- Builder for
ClientAddrConfig
. - Error from trying to parse a MultilineListBuilder as a list of particular items
- The name of a Pluggable Transport protocol.
- Configuration for where information should be stored on disk.
- Builder for
StorageConfig
. - Configuration for client behavior relating to stream connection timeouts
- Builder for
StreamTimeoutConfig
. - A configuration used to bootstrap a
TorClient
. - Builder for
TorClientConfig
. - Wrapper struct to help derive_builder find the right types and methods
- Identify a type of Transport.
- VanguardConfig
vanguards
and (onion-service-client
oronion-service-service
)Vanguards configuration.
Enums§
- Boolean, but with additional
"auto"
option - BridgeParseError
bridge-client
Error when parsing a bridge line from a string - An error that has occurred while expanding a path.
- The way to approach a single relay in order to open a channel.
- An error related to an option passed to Arti via a configuration builder.
- An error that occurs while trying to read and process our configuration.
- A configuration file or directory, for use by a
ConfigurationSources
- Configuration item specifiable as a list, or a single multi-line string
- Rules for reconfiguring a running Arti instance.
Constants§
- The environment variable we look at when deciding whether to disable FS permissions checking.
Traits§
- Extension trait for
MistrustBuilder
to convert the error type on build. - An object that can be connected to via
ChannelMethod
s.
Functions§
- Generic logic to check if bridges should be used or not
- Helper to convert convert_override_net_params
- Return the default cache directory.
- Return the filenames for the default user configuration files
- Return the default stream timeout
- Return the default PTR resolve timeout
- Return the default resolve timeout
- Return the default state directory.
- fs_permissions_checks_disabled_via_envDeprecatedReturn true if the environment has been set up to disable FS permissions checking.
- Check that the bridge configuration is right
- Determine if we need any pluggable transports.
Type Aliases§
- List of configured bridges, as found in the built configuration
- A list of configured transport binaries (type alias for macrology).