Struct HealthCheck 

pub struct HealthCheck {
    pub name: String,
    check_fn: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = HealthStatus> + Send>> + Send + Sync>,
    pub is_liveness: bool,
    pub is_readiness: bool,
    pub timeout: Duration,
    last_result: RwLock<RawRwLock, Option<HealthCheckResult>>,
}

A health check definition.

Fields

name: String

Check name.

check_fn: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = HealthStatus> + Send>> + Send + Sync>

is_liveness: bool

Whether this is a liveness check.

is_readiness: bool

Whether this is a readiness check.

timeout: Duration

Timeout for check execution.

last_result: RwLock<RawRwLock, Option<HealthCheckResult>>

Implementations

impl HealthCheck

pub fn new( name: impl Into<String>, check_fn: Arc<dyn Fn() -> Pin<Box<dyn Future<Output = HealthStatus> + Send>> + Send + Sync>, ) -> HealthCheck

Create a new health check.

pub fn liveness(self) -> HealthCheck

Mark as liveness check.

pub fn readiness(self) -> HealthCheck

Mark as readiness check.

pub fn timeout(self, timeout: Duration) -> HealthCheck

Set timeout.

pub async fn check(&self) -> HealthCheckResult

Execute the health check.

pub fn last_result(&self) -> Option<HealthCheckResult>

Get last check result.