Struct Report 

pub struct Report {
    pub status: &'static str,
    pub checks: BTreeMap<String, Outcome>,
}

The whole report.

Fields

status: &'static str

"ok" when every check passed.

checks: BTreeMap<String, Outcome>

Each check, by name.

Implementations

impl Report

pub fn is_healthy(&self) -> bool

Whether every check passed.

pub fn status_code(&self) -> StatusCode

The status a probe should read.

503, not 500: a dependency being down means “try another replica, try again shortly”, and that is what a load balancer and a retrying client both need to hear. A 500 says this service is broken, which invites a different and slower response from whoever is paged.

pub fn failing(&self) -> Vec<&str>

The names that failed.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Serialize for Report

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

where __S: Serializer,

Serialize this value into the given Serde serializer.