Struct cfg_rs::RefValue

pub struct RefValue<T>(_, _);

RefValue means reference of value or refreshable value, it holds a value which can be updated when Configuration is refreshed.

It implements FromConfig, user can use it in auto deriving config objects.

But it is not supporting recursively usage, following example will cause runtime error:

#[derive(FromConfig)]
struct A {
  ref_b: RefValue<B>,
}
#[derive(FromConfig)]
struct B {
  ref_c: RefValue<u8>,
}

Implementations

impl<T> RefValue<T>

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

Use referenced value, be careful with lock.

impl<T: Clone> RefValue<T>

pub fn get(&self) -> Result<T, ConfigError>

Get cloned value.

Trait Implementations

impl<T> Clone for RefValue<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: FromConfig + Send + 'static> FromConfig for RefValue<T>

fn from_config(
    context: &mut ConfigContext<'_>,
    value: Option<ConfigValue<'_>>
) -> Result<Self, ConfigError>

Generate config from ConfigValue under context.