Skip to main content

WatcherHandle

Struct WatcherHandle 

Source
pub struct WatcherHandle { /* private fields */ }
Expand description

Owns the watcher background thread. Drop to stop watching.

notify-debouncer-mini spawns its background thread inside the debouncer struct; dropping the struct kills the thread and discards events still inside the debounce window. Consumers should hold this handle for the lifetime of their server and call WatcherHandle::retarget when their inputs change instead of replacing it.

Implementations§

Source§

impl WatcherHandle

Source

pub fn retarget(&mut self, targets: WatchTargets) -> Result<()>

Replace the watched roots, exact files, and ignored subtrees in place.

A replacement watcher would discard events this one has observed but not yet debounced, losing edits made while a host refreshes its inputs. Retargeting keeps the debouncer and unchanged roots registered, so those events are still delivered. Content baselines restart as they would for a new watcher: exact files are re-hashed and other paths forward their next event.

§Errors

Returns the first error from a path that exists but cannot be watched. The remaining paths are still registered, including requested roots nested inside the failed path, and the failed path is retried on the next retarget.

Auto Trait Implementations§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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