arti_client_base_resolver

tor_config_path

Function arti_client_base_resolver 

Source 
pub fn arti_client_base_resolver() -> CfgPathResolver
Available on crate feature arti-client only.
Expand description

A CfgPathResolver with the base variables configured for a TorClientConfig in arti-client.

A TorClientConfig may set additional variables on its resolver.

This should only be used by TorClient users and others that need to use the same variables. Libraries should be written in a resolver-agnostic way (shouldn’t rely on resolving ARTI_CONFIG for example).

The supported variables are:

  • ARTI_CACHE: an arti-specific cache directory.
  • ARTI_CONFIG: an arti-specific configuration directory.
  • ARTI_SHARED_DATA: an arti-specific directory in the user’s “shared data” space.
  • ARTI_LOCAL_DATA: an arti-specific directory in the user’s “local data” space.
  • PROGRAM_DIR: the directory of the currently executing binary. See documentation for std::env::current_exe for security notes.
  • USER_HOME: the user’s home directory.

These variables are implemented using the directories crate, and so should use appropriate system-specific overrides under the hood. (Some of those overrides are based on environment variables.) For more information, see that crate’s documentation.