Struct Readiness 

pub struct Readiness { /* private fields */ }

Shareable readiness latch for exposing a /readyz endpoint.

Defaults to NotReady. Application code should call mark_ready() once initialization completes.

Thread-safety

This type is cheaply clonable and can be shared across threads.

Implementations

impl Readiness

pub fn new() -> Self

Create a new latch in the default state.

pub fn state(&self) -> ReadinessState

Get the current readiness state.

pub fn is_ready(&self) -> bool

Returns true if the state is ReadinessState::Ready.

Note: ReadinessState::ShuttingDown is treated as “not ready”.

pub fn mark_not_ready(&self)

Mark the service as not ready.

pub fn mark_ready(&self)

Mark the service as ready.

pub fn mark_shutting_down(&self)

Mark the service as shutting down.

Trait Implementations

impl Clone for Readiness

fn clone(&self) -> Readiness

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Readiness

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

Formats the value using the given formatter.

impl Default for Readiness

fn default() -> Readiness

Returns the “default value” for a type.