Struct RemoteWatch 

pub struct RemoteWatch { /* private fields */ }

A running blocking watch, from the caller’s side.

Dropping it stops the loop — the same contract the file watcher’s WatchHandle has, for the same reason: a watch nobody owns is a leak nobody asked for. detach is the way to say this one really should run forever.

Only blocking loops need this. An async watch is a future: drop it and it is cancelled, on any executor.

let watch = RemoteWatch::new();
let watching = watch.watching();

std::thread::spawn(move || consul.watch(watching, apply));

// ... and later, or by dropping `watch`:
watch.stop();

Implementations

impl RemoteWatch

pub fn new() -> Self

A handle for a watch that has not been handed to a loop yet.

pub fn watching(&self) -> Watching

The loop’s half of this handle.

Hand it to the watch; keep the RemoteWatch yourself.

pub fn stop(&self)

Stops the loop at its next check.

At its next check is the whole caveat, and it is not small: a loop parked in a blocking query does not return until the store answers or the wait expires, so the store’s wait time is the worst-case delay. Each companion crate documents its own.

pub fn is_stopped(&self) -> bool

Whether the loop has been told to stop.

pub fn detach(self)

Watches for the remainder of the process.

Leaks the handle on purpose, exactly as the file watcher’s WatchHandle::detach does: a watch that must never stop has no owner to hold it, and pretending otherwise is how it ends up stopped at the end of main’s first statement.

Trait Implementations

impl Debug for RemoteWatch

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

Formats the value using the given formatter.

impl Default for RemoteWatch

fn default() -> Self

Returns the “default value” for a type.

impl Drop for RemoteWatch

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.