Struct arti::cfg::ArtiConfig

pub struct ArtiConfig {
    application: ApplicationConfig,
    proxy: ProxyConfig,
    logging: LoggingConfig,
    pub(crate) system: SystemConfig,
}

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.

By default, Arti will run using the default Tor network, store state and cache information to a per-user set of directories shared by all that user’s applications, and run a SOCKS client on a local port.

NOTE: These are NOT the final options or their final layout. Expect NO stability here.

Fields

application: ApplicationConfig

Configuration for application behavior.

proxy: ProxyConfig

Configuration for proxy listeners

logging: LoggingConfig

Logging configuration

system: SystemConfig

Information on system resources used by Arti.

Implementations

impl ArtiConfig

pub fn builder() -> ArtiConfigBuilder

Returns a fresh, default, builder

impl ArtiConfig

pub fn application(&self) -> &ApplicationConfig

Return the ApplicationConfig for this configuration.

pub fn logging(&self) -> &LoggingConfig

Return the LoggingConfig for this configuration.

pub fn proxy(&self) -> &ProxyConfig

Return the ProxyConfig for this configuration.

Trait Implementations

impl Clone for ArtiConfig

fn clone(&self) -> ArtiConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArtiConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ArtiConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<ArtiConfig> for ArtiConfig

fn eq(&self, other: &ArtiConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TopLevel for ArtiConfig

type Builder = ArtiConfigBuilder

The Builder which can be used to make a Self

const DEPRECATED_KEYS: &'static [&'static str] = _

Deprecated config keys, as “.”-separates strings

impl Eq for ArtiConfig

impl StructuralEq for ArtiConfig

impl StructuralPartialEq for ArtiConfig