Struct health::PeriodicChecker

pub struct PeriodicChecker<C> { /* fields omitted */ }

A health reporter that periodically updates its status based on the result an underlying Checkable resource

Implementations

impl<C: Checkable> PeriodicChecker<C>

pub fn new(checkable: C, config: Config) -> Self

Creates a new health check for the Checkable resource

pub async fn run(self) -> !

Begins the health check loop and never returns

This function consumes the checker and begins executing periodic checks on the underlying Checkable. The returned Future should not be .awaited, as it never completes. Instead, the Future should be spawned onto an executor, which will continuously poll the Future and drive it to work.

As this function consumes the PeriodicChecker<C>, it will be cloned prior to being passed in so that it can also be passed to some sort of reporting function.

Trait Implementations

impl<C> Clone for PeriodicChecker<C>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C> Debug for PeriodicChecker<C>

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

Formats the value using the given formatter.

impl<C: Checkable> Reporter for PeriodicChecker<C>

fn raw_status(&self) -> Status

The current health status without consideration for when the health status was last updated

fn status(&self) -> Option<Status>

The current health status or None if the health check hasn't updated its internal state within the leeway time

fn last_check(&self) -> Check

The result of the most recent health check