Enum HealthStatus 

pub enum HealthStatus {
    Pass,
    Fail,
    Warn,
}

RFC 8458 §3 health check status.

Serializes as lowercase "pass", "fail", or "warn".

Examples

use api_bones::health::HealthStatus;

let pass = HealthStatus::Pass;
let fail = HealthStatus::Fail;
let warn = HealthStatus::Warn;

assert_eq!(pass.http_status(), 200);
assert_eq!(fail.http_status(), 503);
assert_eq!(warn.http_status(), 200);

Variants

Pass

The service is healthy and all checks pass.

Fail

The service is unhealthy; callers should not route traffic here.

Warn

The service is degraded but still operational.

Implementations

impl HealthStatus

pub const fn http_status(&self) -> u16

HTTP status code for a response carrying this health status.

• Pass / Warn → 200 OK
• Fail → 503 Service Unavailable

Examples

use api_bones::health::HealthStatus;

assert_eq!(HealthStatus::Pass.http_status(), 200);
assert_eq!(HealthStatus::Warn.http_status(), 200);
assert_eq!(HealthStatus::Fail.http_status(), 503);

pub const fn is_available(&self) -> bool

Returns true if the status indicates healthy or degraded-but-operational.

Examples

use api_bones::health::HealthStatus;

assert!(HealthStatus::Pass.is_available());
assert!(HealthStatus::Warn.is_available());
assert!(!HealthStatus::Fail.is_available());

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