Crate tor_config
source · [−]Expand description
tor-config
: Tools for configuration management in Arti
Overview
This crate is part of Arti, a project to implement Tor in Rust.
It provides types for handling configuration values, and general machinery for configuration management.
Configuration in Arti
The configuration for the arti
command line program,
and other programs which embed Arti reusing the configuration machinery,
works as follows:
-
We use
tor_config::ConfigurationSources
to enumerate the various places where configuration information needs to come from, and configure how they are to be read.arti
usesConfigurationSources::from_cmdline
. -
ConfigurationSources::load
actually reads all of these sources, parses them (eg, as TOML files), and returns aconfig::Config
. This is a tree-structured dynamically typed data structure, mirroring the input configuration structure, largely unvalidated, and containing everything in the input config sources. -
We call one of the
tor_config::resolve
family. This maps the input configuration data to concreteConfigBuilder
s for the configuration consumers within the program. (Forarti
, that’sTorClientConfigBuilder
andArtiBuilder
). This mapping is done using theDeserialize
implementations on theBuilder
s.resolve
then calls thebuild()
method on each of these parts of the configuration which applies defaults and validates the resulting configuation.It is important to call
resolve
once for all the configuration consumers, so that it sees a unified view of which config settings in the input were unrecognized, and therefore may need to be reported to the user. See the example in theload
module documentation. -
The resulting configuration objects (eg,
TorClientConfig
,ArtiConfig
) are provided to the code that must use them (eg, to make aTorClient
).
See the
tor_config::load
module-level documentation.
for an example.
⚠ Stability Warning ⚠
The design of this crate, and of the configuration system for Arti, is likely to change significantly before the release of Arti 1.0.0. For more information see ticket #285.
Re-exports
pub use cmdline::CmdLine;
pub use config as config_crate;
pub use educe;
pub use load::resolve;
pub use load::resolve_ignore_unrecognized;
pub use load::resolve_return_unrecognized;
pub use serde;
pub use sources::ConfigurationSources;
Modules
Implement a configuration source based on command-line arguments.
Lists in builders
Processing a config::Config into a validated configuration
ConfigurationSources
: Helper for handling configuration files
Macros
Define accessor methods for a configuration item which is a list
Define a list builder struct for use with define_list_builder_accessors
Defines standard impls for a struct with a Builder
, incl Default
Helper for assisting with macro “argument” defaulting
Structs
A path in a configuration file: tilde expansion is performed, along with expansion of certain variables.
A mutable configuration object.
Enums
An error that has occurred while expanding a path.
An error related to an option passed to Arti via a configuration builder.
Rules for reconfiguring a running Arti instance.
An error caused when attempting to reconfigure an existing Arti client, or one of its modules.