Struct HealthCheckRegistry 

pub struct HealthCheckRegistry { /* private fields */ }

Registry and concurrent runner for product-provided health checks.

The registry owns scope selection, timeout handling, panic-to-report conversion, concurrent execution, registration-order output, and aggregate status calculation. Product code owns the actual probe logic and should return a HealthComponentReport with product-specific diagnostics.

Implementations

impl HealthCheckRegistry

pub fn new() -> Self

Creates an empty health check registry.

pub fn configured<F>(configure: F) -> Self

where F: FnOnce(&mut Self),

Creates a registry and applies one registration function.

This is the lightweight path for product code that only needs to run health probes. Use RuntimeComponentRegistry only when the caller also needs component metadata or shutdown phases.

pub fn configure<F>(&mut self, configure: F) -> &mut Self

where F: FnOnce(&mut Self),

Applies one registration function and returns the registry.

The shape intentionally mirrors Actix Web’s configure pattern, so subsystem modules can expose small registration functions without owning the root registry.

pub fn register_with_options<F, Fut>( &mut self, name: &'static str, options: HealthCheckOptions, check: F, ) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = HealthComponentReport> + Send + 'static,

Registers a health check with full options.

name is also used for timeout and panic reports. The check future should return a component report with the same stable name.

pub fn register_required<F, Fut>( &mut self, name: &'static str, timeout: Option<Duration>, check: F, ) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = HealthComponentReport> + Send + 'static,

Registers a required health check.

pub fn register_optional<F, Fut>( &mut self, name: &'static str, timeout: Option<Duration>, check: F, ) -> &mut Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = HealthComponentReport> + Send + 'static,

Registers an optional health check.

pub async fn run(&self) -> SystemHealthReport

Runs registered checks concurrently and returns an aggregate report.

Component reports are returned in registration order even though checks run concurrently.

pub async fn run_scope(&self, scope: HealthCheckScope) -> SystemHealthReport

Runs only checks registered for scope.

pub fn len(&self) -> usize

Returns how many health checks are registered.

pub fn is_empty(&self) -> bool

Returns whether no health checks are registered.

pub fn descriptors(&self) -> Vec<HealthCheckDescriptor>

Returns registered check descriptors in registration order.

pub fn descriptors_for_scope( &self, scope: HealthCheckScope, ) -> Vec<HealthCheckDescriptor>

Returns registered descriptors that belong to scope.

Trait Implementations

impl Default for HealthCheckRegistry

fn default() -> HealthCheckRegistry

Returns the “default value” for a type.