Enum HealthStatus 

pub enum HealthStatus {
    Ok,
    Warn,
    Fail,
    Unknown,
}

Where one dimension of the system stands. Ordered by severity, so the worst check decides the whole.

Variants

Ok

The engine that decides this dimension is satisfied.

Warn

Nothing is broken and something is worth looking at.

Fail

The engine that decides this dimension is not satisfied.

Unknown

This process cannot decide it, and says so rather than reporting ok.

Implementations

impl HealthStatus

pub fn as_str(self) -> &'static str

The word as serialised.

use majordomus_cli::capability::builtin::health::HealthStatus;
assert_eq!(HealthStatus::Warn.as_str(), "warn");

pub fn worse(self, other: Self) -> Self

The worse of two: the whole is as good as its worst check, and unknown is worse than warn because an undecided dimension is not a healthy one.

use majordomus_cli::capability::builtin::health::HealthStatus::*;
assert_eq!(Ok.worse(Warn), Warn);
assert_eq!(Fail.worse(Unknown), Unknown);

Trait Implementations

impl Clone for HealthStatus

fn clone(&self) -> HealthStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HealthStatus

impl Debug for HealthStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HealthStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for HealthStatus

impl JsonSchema for HealthStatus

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for HealthStatus

fn cmp(&self, other: &HealthStatus) -> 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 HealthStatus

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

fn partial_cmp(&self, other: &HealthStatus) -> 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 Serialize for HealthStatus

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HealthStatus