Module cfg

Expand description

Configuration for the Arti command line application

Macros§

impl_standard_builder 🔒: Defines standard impls for a struct with a Builder, incl Default

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.
ArtiStorageConfig: Configuration for arti-specific storage locations.
ArtiStorageConfigBuilder: Builder for ArtiStorageConfig.
Listen 🔒: Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)
MetricsConfig: Configuration for exporting metrics (eg, perf data)
MetricsConfigBuilder: Builder for MetricsConfig.
PrometheusConfig: Configuration for one or more proxy listeners.
PrometheusConfigBuilder: Builder for PrometheusConfig.
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.

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

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

default_max_files 🔒: Return the default maximum number of file descriptors to launch with.
default_port_info_file 🔒: Return the default ports_info_file location.

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