Expand description
Configuration for the Arti command line application
Macros§
- impl_
standard_ 🔒builder - Defines standard impls for a struct with a
Builder, inclDefault - resolve_
listen_ 🔒port Deprecated - Resolves values from
$field_listenand$field_port(compat) into aListen
Structs§
- Application
Config - Structure to hold our application configuration options
- Application
Config Builder - Builder for
ApplicationConfig. - Arti
Config - 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
artiso that other applications can parse and use them, if desired. If you’re only embedding arti viaarti-client, and you don’t want to use Arti’s configuration format, use [arti_client::TorClientConfig] instead. - Arti
Config Builder - Builder for
ArtiConfig. - Listen 🔒
- Specification of (possibly) something to listen on (eg, a port, or some addresses/ports)
- Metrics
Config - Configuration for exporting metrics (eg, perf data)
- Metrics
Config Builder - Builder for
MetricsConfig. - Prometheus
Config - Configuration for one or more proxy listeners.
- Prometheus
Config Builder - Builder for
PrometheusConfig. - Proxy
Config - Configuration for one or more proxy listeners.
- Proxy
Config Builder - Builder for
ProxyConfig. - RpcConfig
rpc - Configuration for Arti’s RPC subsystem.
- RpcConfig
Builder rpc - Builder for
RpcConfig. - System
Config - Configuration for system resources used by Tor.
- System
Config Builder - Builder for
SystemConfig.
Enums§
- Config
Build 🔒Error - 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.
Type Aliases§
- Arti
Combined Config - Convenience alias for the config for a whole
artiprogram