Enum HealthCheckResult 

pub enum HealthCheckResult {
    Healthy,
    Degraded {
        reason: String,
    },
    Unhealthy {
        reason: String,
    },
}

Result of an individual health check.

Health checks can return one of three states:

• Healthy: The component is functioning normally
• Degraded: The component is functioning but with reduced capacity or performance
• Unhealthy: The component is not functioning correctly

The overall system health is determined by the worst individual check result, with the precedence: Unhealthy > Degraded > Healthy

Variants

Healthy

The component is functioning normally

Degraded

The component is functioning but degraded

This typically indicates reduced capacity, elevated latency, or other non-critical issues that don’t prevent operation.

Fields

reason: String

Human-readable reason for the degraded state

Unhealthy

The component is not functioning correctly

This indicates a critical issue that prevents normal operation.

Fields

reason: String

Human-readable reason for the unhealthy state

Implementations

impl HealthCheckResult

pub fn is_healthy(&self) -> bool

Returns true if the result is Healthy

pub fn is_degraded(&self) -> bool

Returns true if the result is Degraded

pub fn is_unhealthy(&self) -> bool

Returns true if the result is Unhealthy

pub fn reason(&self) -> Option<&str>

Returns the reason string if available

Trait Implementations

impl Clone for HealthCheckResult

fn clone(&self) -> HealthCheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckResult

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

Formats the value using the given formatter.

impl PartialEq for HealthCheckResult

fn eq(&self, other: &HealthCheckResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HealthCheckResult

impl StructuralPartialEq for HealthCheckResult