Struct HealthCheck 

pub struct HealthCheck {
    pub status: HealthStatus,
    pub component: String,
    pub message: Option<String>,
    pub response_time_ms: Option<i64>,
    pub metadata: Option<HashMap<String, Value>>,
}

Detailed health check result for a component.

Fields

status: HealthStatus

Overall health status

component: String

Component name

message: Option<String>

Detailed status message

response_time_ms: Option<i64>

Response time in milliseconds (if applicable)

metadata: Option<HashMap<String, Value>>

Additional metadata

Implementations

impl HealthCheck

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

Create a healthy check result.

pub fn degraded( component: impl Into<String>, message: impl Into<String>, ) -> Self

Create a degraded check result.

pub fn unhealthy( component: impl Into<String>, message: impl Into<String>, ) -> Self

Create an unhealthy check result.

pub fn with_response_time(self, ms: i64) -> Self

Set the response time.

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

Add metadata.

Trait Implementations

impl Clone for HealthCheck

fn clone(&self) -> HealthCheck

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for HealthCheck

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for HealthCheck

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthCheck

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HealthCheck

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for HealthCheck

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl StructuralPartialEq for HealthCheck