ConfigWatcher

Struct ConfigWatcher 

Source
pub struct ConfigWatcher<T>
where T: DeserializeOwned + Clone + Send + Sync + 'static,
{ /* private fields */ }
Expand description

Hot-reload configuration watcher

Watches a configuration file for changes and automatically reloads it. Validates new configurations before applying them.

§Type Parameters

  • T - The configuration type (must implement DeserializeOwned + Clone + Send + Sync)

§Example

use mecha10::config_watcher::ConfigWatcher;
use serde::Deserialize;

#[derive(Debug, Clone, Deserialize)]
struct AppConfig {
    port: u16,
    debug: bool,
}

let watcher = ConfigWatcher::new("config.yaml", |config: &AppConfig| {
    println!("Port changed to: {}", config.port);
})?;

// Get current config
let config = watcher.get();

Implementations§

Source§

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

Source

pub fn new<P, F>(path: P, on_change: F) -> Result<Self>
where P: AsRef<Path>, F: Fn(&T) + Send + Sync + 'static,

Create a new configuration watcher

§Arguments
  • path - Path to configuration file
  • on_change - Callback invoked when configuration changes
§Returns

A new ConfigWatcher instance

§Errors

Returns error if:

  • File doesn’t exist
  • Initial configuration is invalid
  • File watcher can’t be created
§Example
let watcher = ConfigWatcher::new("config.yaml", |config: &MyConfig| {
    // Handle configuration change
    println!("Config updated!");
})?;
Source

pub fn get(&self) -> T

Get the current configuration

Returns a clone of the current configuration.

§Example
let config = watcher.get();
println!("Current rate: {}", config.rate);
Source

pub async fn get_async(&self) -> T

Get the current configuration asynchronously

Returns a clone of the current configuration.

§Example
let config = watcher.get_async().await;
println!("Current rate: {}", config.rate);
Source

pub async fn reload(&self) -> Result<()>

Manually reload the configuration

Forces a reload of the configuration from disk.

§Returns

Ok(()) if reload succeeded, Err if loading or validation failed

§Example
watcher.reload().await?;
Source

pub fn path(&self) -> &Path

Get the path to the configuration file

Auto Trait Implementations§

§

impl<T> Freeze for ConfigWatcher<T>

§

impl<T> !RefUnwindSafe for ConfigWatcher<T>

§

impl<T> Send for ConfigWatcher<T>

§

impl<T> Sync for ConfigWatcher<T>

§

impl<T> Unpin for ConfigWatcher<T>

§

impl<T> !UnwindSafe for ConfigWatcher<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more