Struct HealthResponse 

pub struct HealthResponse {
    pub status: HealthStatus,
    pub version: Option<String>,
    pub checks: Option<HashMap<String, ComponentHealth>>,
}

Health check response

Fields

status: HealthStatus

Service status

version: Option<String>

Service version

checks: Option<HashMap<String, ComponentHealth>>

Component health checks

Implementations

impl HealthResponse

pub fn healthy() -> Self

Create a healthy response

pub fn with_version(self, version: impl Into<String>) -> Self

Create a response with version

pub fn with_check( self, name: impl Into<String>, health: ComponentHealth, ) -> Self

Add a component health check

pub fn compute_status(self) -> Self

Determine overall health status from component checks

Trait Implementations

impl Debug for HealthResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoResponse for HealthResponse

fn into_response(self) -> Response

Create a response.

impl Serialize for HealthResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.