Skip to main content

SettingsHandle

Struct SettingsHandle 

Source
pub struct SettingsHandle<T> { /* private fields */ }

Implementations§

Source§

impl<T> SettingsHandle<T>
where T: Clone + Send + Sync + 'static,

Source

pub fn new(initial: T, backend: Box<dyn StorageBackend>) -> Self

Creates a settings handle and initializes diff state from the backend.

Source

pub fn new_with_stored( initial: T, backend: Box<dyn StorageBackend>, stored: HashMap<String, StoredValue>, ) -> Self

Creates a settings handle with caller-provided persisted values.

This constructor is used when startup code has already loaded persisted values to resolve the initial settings snapshot. Passing the same map into the handle keeps the cross-process diff state aligned with that snapshot without reading the backend a second time.

Source

pub fn new_with_stored_and_applier( initial: T, backend: Box<dyn StorageBackend>, stored: HashMap<String, StoredValue>, external_applier: ExternalApplier<T>, ) -> Self

Creates a settings handle with caller-provided persisted values and an external applier.

This constructor is used by generated settings code that has already loaded stored values and can also map persisted storage keys back onto fields in T. The applier is called when the cross-process diff loop observes an external stored-value change; successful applications update the in-memory snapshot before the corresponding change event is broadcast.

Source

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

Source

pub fn on_change(&self) -> Receiver<ChangeEvent>

Source

pub fn write_field( &self, key: &str, old_value: Option<StoredValue>, new_value: StoredValue, mutator: impl FnOnce(&mut T), ) -> Result<(), SettingsError>

Trait Implementations§

Source§

impl<T> Clone for SettingsHandle<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for SettingsHandle<T>

§

impl<T> !UnwindSafe for SettingsHandle<T>

§

impl<T> Freeze for SettingsHandle<T>

§

impl<T> Send for SettingsHandle<T>
where T: Sync + Send,

§

impl<T> Sync for SettingsHandle<T>
where T: Sync + Send,

§

impl<T> Unpin for SettingsHandle<T>

§

impl<T> UnsafeUnpin for SettingsHandle<T>

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.