Skip to main content

ConfigWatcher

Struct ConfigWatcher 

Source
pub struct ConfigWatcher<T> { /* private fields */ }
Expand description

A handle that receives updated configuration values when watched files change.

Created by ConfigurationLoader::watch. The watcher runs on a background thread and sends the latest successfully loaded value through the channel.

§Hot-reload limitations

  • Only config values read through latest are live-updated.
  • The DI container and already-constructed providers retain their original values unless they explicitly poll this watcher.

Implementations§

Source§

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

Source

pub fn latest(&self) -> Option<T>

Returns a clone of the most recently loaded configuration, or None if none has been loaded yet.

Source

pub fn receiver(&self) -> Receiver<Option<T>>

Returns a receiver that can be used to await the next config update.

Trait Implementations§

Source§

impl<T: Debug> Debug for ConfigWatcher<T>

Available on crate feature hot-reload only.
Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for ConfigWatcher<T>

§

impl<T> !UnwindSafe for ConfigWatcher<T>

§

impl<T> Freeze for ConfigWatcher<T>

§

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

§

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

§

impl<T> Unpin for ConfigWatcher<T>

§

impl<T> UnsafeUnpin 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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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, 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