Struct HeartbeatWatch 

pub struct HeartbeatWatch { /* private fields */ }

A running heartbeat-file watch. Dropping it stops and joins the thread.

The age is measured from the file’s modification time. A file that is missing (or whose modification time cannot be read) keeps aging from the last time it was seen, or from when the watch started if it was never seen, so a writer that never starts is reported too.

Implementations

impl HeartbeatWatch

pub fn spawn( name: &str, config: HeartbeatConfig, on_event: impl Fn(HeartbeatEvent) + Send + 'static, ) -> Result<Self>

Starts watching config.path. on_event runs on the watch thread, so keep it short.

pub fn stop(&mut self)

Stop and join. Idempotent.

Trait Implementations

impl Drop for HeartbeatWatch

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.