Struct kumo_server_common::config_handle::ConfigHandle

pub struct ConfigHandle<T: Clone + Send> { /* private fields */ }

ConfigHandle allows sharing a configuration value of some type T without requiring full Mutex around every read operation.

The update method update the upstream value, bumping the generation counter in the process.

The borrow method will return a Guard referencing the value without requiring a Mutex lock operation.

Implementations

impl<T: Clone + Send> ConfigHandle<T>

pub fn new(value: T) -> Self

pub fn generation(&self) -> usize

pub fn update(&self, new_value: T) -> usize

Updates the upstream, shared value. Other config handles will notice the change when borrow() is subsequently called.

pub fn borrow(&self) -> Guard<Arc<T>>

Borrows the local copy of the config for read. The local copy will be updated from the upstream if necessary.

Trait Implementations

impl<T: Clone + Clone + Send> Clone for ConfigHandle<T>

fn clone(&self) -> ConfigHandle<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Clone + Send + Debug> Debug for ConfigHandle<T>

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

Formats the value using the given formatter.