Struct DynamicConfig 

pub struct DynamicConfig<T, M = RW> { /* private fields */ }

A struct that contains a piece of configuration that can change.

Implementations

impl<T> DynamicConfig<T, RW>

pub fn add_notify( &self, f: impl Fn(&T) + IsGlobal, ) -> RegistryHandle<Box<dyn Fn(&T) + Send + Sync + 'static>>

Registers a callback to be notified when the configuration changes.

Prefer to use derive() or view().

impl<T, M> DynamicConfig<T, M>

where M: Mode,

pub fn get(&self) -> T

where T: Clone,

Returns the current value.

Note: the returned value is not dynamic.

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Computes a result based on the current configuration value.

Useful when the configuration is not Copy and get() cannot be used.

pub fn view_diff<U>( self: &Arc<Self>, to: impl Fn(&T) -> U + IsGlobal, ) -> Arc<DynamicConfig<U, RO>>

where T: Clone + IsGlobal, U: Clone + IsGlobal + HasDiff,

Returns a derived mode::RO dynamic configuration.

The derived configuration is updated only if the value actually changes.

pub fn view<U>( self: &Arc<Self>, to: impl Fn(&T) -> U + IsGlobal, ) -> Arc<DynamicConfig<U, RO>>

where T: Clone + IsGlobal, U: Clone + IsGlobal,

Returns a derived mode::RO dynamic configuration.

Use view_diff() so the derived config doesn’t notify unless the value actually changes.

pub fn zip<T2, M2>( self: &Arc<Self>, right: &Arc<DynamicConfig<T2, M2>>, ) -> Arc<DynamicConfig<(T, T2), RO>>

where T: Clone + IsGlobal, T2: Clone + IsGlobal, M2: Mode,

impl<T> DynamicConfig<T, RW>

pub fn set(&self, make_new_config: impl FnOnce(&T) -> T)

where T: Clone,

Modifies the current configuration.

This will trigger all handlers registered with add_notify(), such as views or derived configurations.

pub fn try_set<E>( &self, make_new_config: impl FnOnce(&T) -> Result<T, E>, ) -> Result<(), E>

where T: Clone,

Modifies the current configuration.

Same as set() but accepts a mutation that could return an error.

pub fn silent_set(&self, make_new_config: impl FnOnce(&T) -> T)

where T: Clone,

Modifies the current configuration.

Same as set() but will not trigger notify.

pub fn silent_try_set<E>( &self, make_new_config: impl FnOnce(&T) -> Result<T, E>, ) -> Result<(), E>

where T: Clone,

Modifies the current configuration.

Does not trigger notify and accepts a mutation that could return an error.

pub fn derive<U>( self: &Arc<Self>, to: impl Fn(&T) -> U + IsGlobal, from: impl Fn(T, &U) -> Option<T> + IsGlobal, ) -> Arc<DynamicConfig<U, RW>>

where T: Clone + IsGlobal, U: Clone + IsGlobal + HasDiff,

Returns a derived piece of configuration.

Unlike view(), changes made to the derived configuration are applied back to the original configuration.

impl<T> DynamicConfig<T>

pub fn if_change<U>( from: impl Fn(&T, &U) -> T + 'static, ) -> impl Fn(T, &U) -> Option<T> + 'static

where T: Eq,

pub fn if_ptr_change<U>( from: impl Fn(&Arc<T>, &U) -> Arc<T> + 'static, ) -> impl Fn(Arc<T>, &U) -> Option<Arc<T>> + 'static

Trait Implementations

impl<T: Debug, M: Mode> Debug for DynamicConfig<T, M>

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

Formats the value using the given formatter.

impl<T: Default, M: Default> Default for DynamicConfig<T, M>

fn default() -> DynamicConfig<T, M>

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for DynamicConfig<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<T> for DynamicConfig<T, RW>

fn from(config: T) -> Self

Converts to this type from the input type.

impl<T: Serialize> Serialize for DynamicConfig<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.