Module cfg

Configuration for the Arti command line application

Macros

• impl_standard_builder 🔒
  Defines standard impls for a struct with a Builder, incl Default
• resolve_listen_port 🔒 Deprecated
  Resolves values from $field_listen and $field_port (compat) into a Listen

Structs

• ApplicationConfig
  Structure to hold our application configuration options
• ApplicationConfigBuilder
  Builder for ApplicationConfig.
• ArtiConfig
  Structure to hold Arti’s configuration options, whether from a configuration file or the command line. These options are declared in a public crate outside of arti so that other applications can parse and use them, if desired. If you’re only embedding arti via arti-client, and you don’t want to use Arti’s configuration format, use arti_client::TorClientConfig instead.
• ArtiConfigBuilder
  Builder for ArtiConfig.
• Listen 🔒
  Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)
• ProxyConfig
  Configuration for one or more proxy listeners.
• ProxyConfigBuilder
  Builder for ProxyConfig.
• RpcConfigrpc
  Configuration for Arti’s RPC subsystem.
• RpcConfigBuilderrpc
  Builder for RpcConfig.
• SystemConfig
  Configuration for system resources used by Tor.
• SystemConfigBuilder
  Builder for SystemConfig.

Enums

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

Constants

• ARTI_EXAMPLE_CONFIG
  Example file demonstrating our configuration and the default options.

Functions

• default_max_files 🔒
  Return the default maximum number of file descriptors to launch with.
• default_rpc_path 🔒 rpc
  Return the default value for our configuration path.

Type Aliases

• ArtiCombinedConfig
  Convenience alias for the config for a whole arti program