Struct HealthCheck 

#[non_exhaustive]
pub struct HealthCheck {
    pub check: String,
    pub healthy: Option<bool>,
    pub result: Option<CheckResult>,
    pub extra: Map<String, Value>,
}

One health-check result within a status push.

JSON schema

{
 "description": "One health-check result within a status push.",
 "type": "object",
 "required": [
   "check"
 ],
 "properties": {
   "check": {
     "description": "Name of the check. Must be a non-empty string, and should stay stable\nacross pushes: results for the same name are correlated over time, so\nsuccessive failures and the eventual recovery land on the same issue.",
     "type": "string"
   },
   "healthy": {
     "description": "Legacy pass/fail form: `true` means `passed`, `false` means `failed`.\nMutually exclusive with `result`.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "result": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "description": "Outcome of the check: `passed`, `warning`, `failed`, `broken`, or\n`skipped`. Exactly one of `result` / `healthy` must be present per\nentry. `warning` and `failed` open the check's issue as graded by\nits policy; `broken` (the check itself errored, not the system under\ntest) neither confirms nor clears a known failure — the issue stays\nopen, retaining its contribution; `skipped` (a precondition was\nnot met) and `passed` open nothing and close prior issues.",
         "$ref": "#/components/schemas/CheckResult"
       }
     ]
   }
 },
 "additionalProperties": true
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

check: String

Name of the check. Must be a non-empty string, and should stay stable across pushes: results for the same name are correlated over time, so successive failures and the eventual recovery land on the same issue.

healthy: Option<bool>

Legacy pass/fail form: true means passed, false means failed. Mutually exclusive with result.

result: Option<CheckResult>

extra: Map<String, Value>

Any further keys the schema accepts alongside those above, carried verbatim.

Implementations

impl HealthCheck

pub fn builder() -> HealthCheckBuilder

Create an instance of HealthCheck using the builder syntax

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