Skip to main content

HealthCheckRegistry

Struct HealthCheckRegistry 

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

Registry of health checks.

Collects named health checks that can be evaluated together to produce a HealthReport.

§Example

let mut registry = HealthCheckRegistry::new();

// Critical check — failure makes the app "unhealthy"
registry.add("database", true, || async {
    // db.ping().await?;
    Ok(())
});

// Non-critical check — failure makes the app "degraded"
registry.add("cache", false, || async {
    // cache.ping().await?;
    Ok(())
});

Implementations§

Source§

impl HealthCheckRegistry

Source

pub fn new() -> Self

Create a new empty registry.

Source

pub fn add<F, Fut>( &mut self, name: impl Into<String>, critical: bool, check_fn: F, )
where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), String>> + Send + 'static,

Add a named health check.

§Parameters
  • name: Identifier for the check (e.g., “database”, “cache”).
  • critical: If true, failure of this check makes the overall status Unhealthy. If false, failure makes it Degraded (unless another critical check fails).
  • check_fn: Async function that returns Ok(()) on success or Err(message) on failure.
Source

pub async fn check_all(&self) -> HealthReport

Run all health checks and produce a report.

Source

pub fn len(&self) -> usize

Returns the number of registered checks.

Source

pub fn is_empty(&self) -> bool

Returns true if no checks are registered.

Trait Implementations§

Source§

impl Default for HealthCheckRegistry

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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
Source§

impl<T> ResponseProduces<T> for T