Skip to main content

ConfigHandle

Struct ConfigHandle 

Source
pub struct ConfigHandle<T: Send + Sync + 'static> { /* private fields */ }
Expand description

A shared handle to a configuration value.

ConfigHandle<T> wraps an Arc<ArcSwap<T>> to provide:

  • load(): Read the current configuration snapshot (returns Arc<T>).
  • set(): Update the configuration value.
  • clone: Share the same underlying swap cell across multiple handles.

Multiple ConfigHandle<T> clones point to the same underlying swap cell. Updates via one handle are immediately visible to all other handles.

Old snapshots (returned by load()) remain valid after updates.

§Type Constraints

T must satisfy Send + Sync + 'static and Sized.

§Example

use trait_kit::core::config::ConfigHandle;

let handle = ConfigHandle::new(42);
assert_eq!(*handle.load(), 42);

let cloned = handle.clone();
handle.set(100);
assert_eq!(*cloned.load(), 100);

Implementations§

Source§

impl<T: Send + Sync + 'static> ConfigHandle<T>

Source

pub fn new(value: T) -> Self

Create a new ConfigHandle with an initial value.

Source

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

Load the current configuration snapshot.

Returns an Arc<T> that remains valid even after subsequent set() calls.

Source

pub fn set(&self, value: T)

Update the configuration value.

All clones of this handle will see the new value on their next load() call.

Trait Implementations§

Source§

impl<T: Send + Sync + 'static> Clone for ConfigHandle<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Send + Sync + 'static> Debug for ConfigHandle<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ConfigHandle<T>

§

impl<T> RefUnwindSafe for ConfigHandle<T>
where T: RefUnwindSafe,

§

impl<T> Send for ConfigHandle<T>

§

impl<T> Sync for ConfigHandle<T>

§

impl<T> Unpin for ConfigHandle<T>

§

impl<T> UnsafeUnpin for ConfigHandle<T>

§

impl<T> UnwindSafe for ConfigHandle<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.