Struct Health 

pub struct Health {
    pub name: String,
    pub status: HealthStatus,
    pub message: Option<String>,
}

Health report from a single component.

Fields

name: String

Component name as returned by crate::Component::name.

status: HealthStatus

Overall health status of the component.

message: Option<String>

Optional human-readable explanation for non-healthy status.

Implementations

impl Health

pub fn healthy(name: impl Into<String>) -> Self

Create a healthy report for the named component.

pub fn degraded(name: impl Into<String>, msg: impl Into<String>) -> Self

Create a degraded report with an explanatory message.

pub fn unhealthy(name: impl Into<String>, msg: impl Into<String>) -> Self

Create an unhealthy report with an explanatory message.

pub fn is_healthy(&self) -> bool

Returns true if the status is HealthStatus::Healthy.

Trait Implementations

impl Clone for Health

fn clone(&self) -> Health

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Health

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

Formats the value using the given formatter.

impl PartialEq for Health

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Health