Struct ReadinessChecks 

pub struct ReadinessChecks { /* private fields */ }

Named readiness checks and their bounds.

Implementations

impl ReadinessChecks

pub fn new() -> Self

No checks; a 2 s timeout, 4 at a time, results kept for 1 s.

pub fn check<F, Fut>(self, name: impl Into<String>, check: F) -> Self

where F: Fn() -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), CheckError>> + Send + 'static,

Add a check named name (shown to clients, so keep it generic: database, not a host name).

Args: name: The check’s public name. check: Returns Ok(()) when the dependency is usable; the error text is logged, never returned.

pub fn timeout(self, timeout: Duration) -> Self

Give each check at most timeout (default 2 s).

pub fn concurrency(self, limit: usize) -> Self

Run at most limit checks at once (default 4, at least 1).

pub fn cache(self, period: Duration) -> Self

Reuse an evaluation for period (default 1 s); zero evaluates on every request, still one at a time.

pub async fn report(&self, ready: bool) -> ReadyReport

The report for a server in ready state, evaluating the checks unless a fresh enough evaluation exists.

Trait Implementations

impl Clone for ReadinessChecks

fn clone(&self) -> ReadinessChecks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadinessChecks

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

Formats the value using the given formatter.

impl Default for ReadinessChecks

fn default() -> Self

Returns the “default value” for a type.