Struct HealthStatus 

pub struct HealthStatus { /* private fields */ }

Result of a liveness or readiness check.

Return HealthStatus::up for healthy dependencies and HealthStatus::down with a safe diagnostic message for unhealthy ones. Messages are included in health JSON by default and can be suppressed with HealthRegistry::hide_details.

Implementations

impl HealthStatus

pub fn up() -> Self

Creates an up health status.

pub fn down(message: impl Into<String>) -> Self

Creates a down health status with a safe diagnostic message.

Keep the message operational and non-sensitive because it is exposed in response bodies unless the registry uses HealthRegistry::hide_details.

pub const fn is_up(&self) -> bool

Returns whether the check is up.

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 Eq for HealthStatus

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 StructuralPartialEq for HealthStatus