Struct HealthResponse

pub struct HealthResponse {
    pub status: bool,
    pub databases: Option<DatabaseStatus>,
    pub services: Option<ServiceStatuses>,
    pub build_timestamp: String,
    pub git_sha: Option<String>,
    pub git_commit_timestamp: Option<String>,
    pub git_branch: Option<String>,
}

Response structure for health check endpoints.

This structure can represent both detailed and minimal health check responses. In minimal mode, only the status and build timestamp are included. In detailed mode, additional information about databases, services, and git metadata is included.

Fields

status: bool

Overall health status of the system. true indicates all checked components are healthy.

databases: Option<DatabaseStatus>

Status of database connections. Omitted in the serialized response if None.

services: Option<ServiceStatuses>

Status of external services. Omitted in the serialized response if None.

build_timestamp: String

Timestamp when the application was built.

git_sha: Option<String>

Git commit SHA of the deployed version. Omitted in the serialized response if None.

git_commit_timestamp: Option<String>

Timestamp of the git commit. Omitted in the serialized response if None.

git_branch: Option<String>

Git branch name of the deployed version. Omitted in the serialized response if None.

Implementations

impl HealthResponse

pub fn new( databases: Option<DatabaseStatus>, services: Option<ServiceStatuses>, ) -> Self

Creates a new HealthResponse instance.

Arguments

• databases - Optional status of database connections
• services - Optional status of external services

Returns

Returns a HealthResponse with computed status and appropriate metadata based on whether this is a detailed or minimal health check.

Trait Implementations

impl Debug for HealthResponse

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

Formats the value using the given formatter.

impl Default for HealthResponse

fn default() -> HealthResponse

Returns the “default value” for a type.

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 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.