Struct HealthCheckResult 

pub struct HealthCheckResult { /* private fields */ }

The result of a health check.

Implementations

impl HealthCheckResult

pub fn builder() -> Builder<StateStage>

Returns a new builder.

impl HealthCheckResult

pub fn state(&self) -> &HealthState

Health state of the check.

pub fn message(&self) -> Option<&str>

Text describing the state of the check which should provide enough information for the check to be actionable when included in an alert.

pub fn params(&self) -> &BTreeMap<String, Any>

Additional redacted information on the nature of the health check.

Trait Implementations

impl Clone for HealthCheckResult

fn clone(&self) -> HealthCheckResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HealthCheckResult

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

Formats the value using the given formatter.

impl Hash for HealthCheckResult

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for HealthCheckResult

fn cmp(&self, other: &HealthCheckResult) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HealthCheckResult

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

fn partial_cmp(&self, other: &HealthCheckResult) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for HealthCheckResult

impl StructuralPartialEq for HealthCheckResult