Struct HealthComponentReport 

pub struct HealthComponentReport {
    pub name: &'static str,
    pub status: HealthStatus,
    pub message: String,
    pub duration: Option<Duration>,
    pub details: Vec<HealthComponentDetail>,
}

Health status for one named component.

Fields

name: &'static str

Stable component name, such as database, cache, or storage.

status: HealthStatus

Component status.

message: String

Human-facing diagnostic message.

duration: Option<Duration>

Duration spent running this component check.

details: Vec<HealthComponentDetail>

Optional structured diagnostics.

Implementations

impl HealthComponentReport

pub fn healthy(name: &'static str, message: impl Into<String>) -> Self

Builds a healthy component report.

pub fn degraded(name: &'static str, message: impl Into<String>) -> Self

Builds a degraded component report.

pub fn unhealthy(name: &'static str, message: impl Into<String>) -> Self

Builds an unhealthy component report.

pub fn with_duration(self, duration: Duration) -> Self

Returns this report with runtime duration attached.

pub fn with_detail( self, key: impl Into<String>, value: impl Into<HealthComponentDetailValue>, ) -> Self

Returns this report with a structured diagnostic detail appended.

pub fn detail(&self, key: &str) -> Option<&HealthComponentDetailValue>

Returns the first structured detail value for key.

pub fn duration_seconds(&self) -> Option<f64>

Returns component duration in seconds, if present.

Trait Implementations

impl Clone for HealthComponentReport

fn clone(&self) -> HealthComponentReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthComponentReport

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

Formats the value using the given formatter.

impl PartialEq for HealthComponentReport

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

impl StructuralPartialEq for HealthComponentReport