Struct arti_client::config::dir::DirMgrConfig

pub struct DirMgrConfig {
    pub cache_path: PathBuf,
    pub cache_trust: Mistrust,
    pub network: NetworkConfig,
    pub schedule: DownloadScheduleConfig,
    pub tolerance: DirSkewTolerance,
    pub override_net_params: NetParams<i32>,
    pub extensions: DirMgrExtensions,
}

Configuration type for network directory operations.

If the directory manager gains new configurabilities, this structure will gain additional supertraits, as an API break.

Prefer to use TorClientConfig, which will always be convertible to this struct via TryInto.

Fields

cache_path: PathBuf

Location to use for storing and reading current-format directory information.

Cannot be changed on a running Arti client.

cache_trust: Mistrust

Rules for whether to trust the the permissions on the cache_path.

network: NetworkConfig

Configuration information about the network.

schedule: DownloadScheduleConfig

Configuration information about when we download things.

This can be replaced on a running Arti client. Doing so affects future download attempts, but has no effect on attempts that are currently in progress or being retried.

(The above is a limitation: we would like it to someday have an effect on in-progress attempts as well, at least at the top level. Users should not assume that the effect of changing this option will always be delayed.)

tolerance: DirSkewTolerance

How much skew do we tolerate in directory validity times?

override_net_params: NetParams<i32>

A map of network parameters that we’re overriding from their settings in the consensus.

This can be replaced on a running Arti client. Doing so will take effect the next time a consensus is downloaded.

(The above is a limitation: we would like it to someday take effect immediately. Users should not assume that the effect of changing this option will always be delayed.)

extensions: DirMgrExtensions

Extra fields for extension purposes.

These are kept in a separate type so that the type can be marked as non_exhaustive and used for optional features.

Implementations

impl DirMgrConfig

pub fn authorities(&self) -> &[Authority]

Return a slice of the configured authorities

pub fn fallbacks(&self) -> &FallbackList

Return the configured set of fallback directories

pub fn update_config(&self, new_config: &DirMgrConfig) -> DirMgrConfig

Construct a new configuration object where all replaceable fields in self are replaced with those from new_config.

Any fields which aren’t allowed to change at runtime are copied from self.

Trait Implementations

impl Clone for DirMgrConfig

fn clone(&self) -> DirMgrConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DirMgrConfig

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

Formats the value using the given formatter.