Struct tor_config::MutCfg

pub struct MutCfg<T> {
    cfg: RwLock<Arc<T>>,
}

A mutable configuration object.

Internally, this is just a RwLock<Arc<T>>; this type just defines some convenience wrappers for it.

Fields

cfg: RwLock<Arc<T>>

The interior configuration object.

Implementations

impl<T> MutCfg<T>

pub fn new(config: T) -> Self

Return a new MutCfg with the provided value.

pub fn get(&self) -> Arc<T>

Return the current configuration

pub fn check_and_replace(&self, old_config: &Arc<T>, new_config: T) -> bool

If this configuration object is still the same pointer as old_config, replace it with new_config.

Returns true if it was in fact replaced.

pub fn replace(&self, new_config: T)

Replace this configuration with new_config.

pub fn map_and_replace<F>(&self, func: F)

where F: FnOnce(&Arc<T>) -> T,

Replace the current configuration with the results of evaluating func on it.

Trait Implementations

impl<T: Debug> Debug for MutCfg<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for MutCfg<T>

fn default() -> MutCfg<T>

Returns the “default value” for a type.

impl<T> From<T> for MutCfg<T>

fn from(config: T) -> MutCfg<T>

Converts to this type from the input type.