Enum HealthStatus 

pub enum HealthStatus {
    Green,
    Yellow,
    Red,
    Unknown,
}

The traffic-light the cluster reports.

Variants

Green

Every shard, primary and replica, is assigned.

Yellow

Every primary is assigned; some replica is not.

Red

At least one primary is unassigned — some data cannot be read at all.

Unknown

A colour this client does not know.

Implementations

impl HealthStatus

pub fn is_usable(self) -> bool

Whether every document can be reached.

Yellow counts. A single-node cluster is yellow the moment an index has one replica configured, which is the default and which no single node can ever satisfy — so a readiness check that demanded green would fail on every developer machine and every scratch container forever.

Trait Implementations

impl Clone for HealthStatus

fn clone(&self) -> Self

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 Display for HealthStatus

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

Formats the value using the given formatter.

impl Eq for HealthStatus

impl PartialEq for HealthStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HealthStatus