Struct ReactiveHealthCheck

pub struct ReactiveHealthCheck { /* private fields */ }

Basic implementation of CheckHealth trait that can be updated using a matching HealthUpdater.

Implementations

impl ReactiveHealthCheck

pub fn new(name: &'static str) -> (Self, HealthUpdater)

Creates a health check together with an updater that can be used to update it. The check will return HealthStatus::NotReady initially.

pub async fn wait_for( &mut self, condition: impl FnMut(&Health) -> bool, ) -> Health

Waits until the specified condition is true for the tracked Health, and returns health. Mostly useful for testing.

If the health updater associated with this check is dropped, this method can wait indefinitely.

Trait Implementations

impl CheckHealth for ReactiveHealthCheck

fn name(&self) -> &'static str

Unique name of the component.

fn check_health<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Health> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks health of the component.

impl Clone for ReactiveHealthCheck

fn clone(&self) -> ReactiveHealthCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReactiveHealthCheck

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

Formats the value using the given formatter.