Enum HealthStatus 

pub enum HealthStatus {
    Healthy,
    Degraded(String),
    Unhealthy(String),
}

The health status of a single component.

Variants

Healthy

Component is operating normally.

Degraded(String)

Component is partially impaired but still serving requests.

Unhealthy(String)

Component is non-functional; requests will fail.

Implementations

impl HealthStatus

pub const fn is_healthy(&self) -> bool

Returns true only when the component is fully healthy.

Example

use stygian_graph::application::health::HealthStatus;
assert!(HealthStatus::Healthy.is_healthy());
assert!(!HealthStatus::Degraded("latency".into()).is_healthy());

pub const fn is_operational(&self) -> bool

Returns true when the component can still serve requests (healthy or degraded).

Example

use stygian_graph::application::health::HealthStatus;
assert!(HealthStatus::Healthy.is_operational());
assert!(HealthStatus::Degraded("high latency".into()).is_operational());
assert!(!HealthStatus::Unhealthy("connection refused".into()).is_operational());

Trait Implementations

impl Clone for HealthStatus

fn clone(&self) -> HealthStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HealthStatus

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

Formats the value using the given formatter.

impl PartialEq for HealthStatus

fn eq(&self, other: &HealthStatus) -> 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 Serialize for HealthStatus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for HealthStatus

impl StructuralPartialEq for HealthStatus