Skip to main content

Module cfg

Module cfg 

Source
Expand description

Configuration for the Arti command line application

Re-exportsΒ§

use derive_deftly::Deftly; πŸ”’
use tor_basic_utils::ByteQty; πŸ”’
use tor_config_path::CfgPath; πŸ”’
use crate::onion_proxy::OnionServiceProxyConfigBuilder; πŸ”’
use crate::onion_proxy::OnionServiceProxyConfigMap; πŸ”’
use crate::onion_proxy::OnionServiceProxyConfigMapBuilder; πŸ”’
pub use crate::rpc::RpcConfig;
pub use crate::rpc::RpcConfigBuilder;
pub use crate::rpc::listener::RpcListenerSetConfig;
pub use crate::rpc::listener::RpcListenerSetConfigBuilder;
use arti_client::TorClientConfig; πŸ”’
use tor_config::define_list_builder_accessors; πŸ”’
use crate::LoggingConfig; πŸ”’
use crate::LoggingConfigBuilder; πŸ”’
use tor_config::derive::prelude::*; πŸ”’

StructsΒ§

ApplicationConfig
Structure to hold our application configuration options
ApplicationConfigBuilder
A builder to create an instance of 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
A builder to create an instance of ArtiConfig.
ArtiStorageConfig
Configuration for arti-specific storage locations.
ArtiStorageConfigBuilder
A builder to create an instance of 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 πŸ”’
A builder to create an instance of MetricsConfig.
ProxyConfig
Configuration for one or more proxy listeners.
ProxyConfigBuilder
A builder to create an instance of ProxyConfig.
SystemConfig
Configuration for system resources used by Tor.
SystemConfigBuilder
A builder to create an instance of 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.
DEFAULT_RECV_BUF_SIZE πŸ”’
See ProxyConfig::socket_recv_buf_size.
DEFAULT_SEND_BUF_SIZE πŸ”’
See ProxyConfig::socket_send_buf_size.

FunctionsΒ§

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.

Type AliasesΒ§

ArtiCombinedConfig
Convenience alias for the config for a whole arti program