Struct ConfigSyncRuntime 

pub struct ConfigSyncRuntime { /* private fields */ }

Namespaced runtime handle for cross-process config synchronization.

This type is the product-facing boundary for config sync. It keeps the namespace, runtime identity, backend notifier, publish helper, and subscription worker wiring together so product crates only provide their authoritative reload callback.

Implementations

impl ConfigSyncRuntime

pub fn new( namespace: impl Into<String>, runtime_id: impl Into<String>, notifier: impl Into<SharedConfigChangeNotifier>, ) -> Self

Creates an enabled runtime from a namespace, runtime ID, and notifier.

pub fn disabled(namespace: impl Into<String>) -> Self

Creates a disabled runtime with a generated runtime ID.

pub fn disabled_with_runtime_id( namespace: impl Into<String>, runtime_id: impl Into<String>, ) -> Self

Creates a disabled runtime with an explicit runtime ID.

pub fn disabled_for_test(namespace: impl Into<String>) -> Self

Creates a disabled runtime for tests and single-process defaults.

pub fn with_notifier_for_test( namespace: impl Into<String>, runtime_id: impl Into<String>, notifier: impl Into<SharedConfigChangeNotifier>, ) -> Self

Creates an enabled runtime from an explicit notifier for tests.

pub fn namespace(&self) -> &str

Returns the product namespace this runtime accepts and publishes.

pub fn runtime_id(&self) -> &str

Returns the process runtime ID.

pub fn notifier(&self) -> Option<&SharedConfigChangeNotifier>

Returns the configured notifier, if cross-process sync is enabled.

pub fn enabled(&self) -> bool

Returns whether config sync is enabled.

pub fn worker_config(&self) -> ConfigReloadWorkerConfig

Converts this runtime into the reload-worker filter configuration.

pub async fn publish_reload( &self, keys: impl IntoIterator<Item = impl Into<String>>, source: ConfigNotificationSource, ) -> Result<()>

Publishes a reload hint after a local config mutation.

pub async fn run_reload_subscription<F, Fut>( &self, shutdown: CancellationToken, reload: F, ) -> Result<()>

where F: FnMut(ConfigReloadMessage) -> Fut, Fut: Future<Output = Result<()>>,

Runs this runtime’s reload subscription worker until shutdown.

Disabled runtimes simply wait for shutdown, which lets callers spawn the same task unconditionally if that is more convenient.

pub async fn run_reload_subscription_with_observer<F, Fut>( &self, shutdown: CancellationToken, reload: F, observer: Option<&dyn ConfigReloadObserver>, ) -> Result<()>

where F: FnMut(ConfigReloadMessage) -> Fut, Fut: Future<Output = Result<()>>,

Runs this runtime’s reload subscription worker and reports observations.

pub async fn run_reload_subscription_with_reconcile<R, RFut, F, Fut>( &self, shutdown: CancellationToken, reconcile: R, reload: F, ) -> Result<()>

where R: FnMut() -> RFut, RFut: Future<Output = Result<()>>, F: FnMut(ConfigReloadMessage) -> Fut, Fut: Future<Output = Result<()>>,

Runs a reconnecting subscription with an authoritative reconcile callback.

reconcile runs after each successful subscription. Product code should reload its full snapshot and invalidate all derived configuration caches.

pub async fn run_reload_subscription_with_reconcile_and_observers<R, RFut, F, Fut>( &self, shutdown: CancellationToken, reconcile: R, reload: F, reload_observer: Option<&dyn ConfigReloadObserver>, connection_observer: Option<&dyn ConfigSyncConnectionObserver>, ) -> Result<()>

where R: FnMut() -> RFut, RFut: Future<Output = Result<()>>, F: FnMut(ConfigReloadMessage) -> Fut, Fut: Future<Output = Result<()>>,

Runs a reconnecting subscription and reports reload and connection observations.

Trait Implementations

impl Clone for ConfigSyncRuntime

fn clone(&self) -> ConfigSyncRuntime

Returns a duplicate of the value.

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

Performs copy-assignment from source.