Struct ReadinessState 

pub struct ReadinessState { /* private fields */ }

Shared, framework-owned readiness state for an OoP gear instance.

Created by the OoP bootstrap with the gear’s critical dependency names and a shared RestHealthcheckRegistry (populated from each gear’s RestApiCapability::healthcheck). Cloned as an Arc into the probe router and the dependency-resolution task.

Implementations

impl ReadinessState

pub fn new<I, S>( critical_deps: I, healthchecks: Arc<RestHealthcheckRegistry>, ) -> Arc<Self>

where I: IntoIterator<Item = S>, S: Into<String>,

Create a new readiness state seeded with the gear’s critical dependency names and the shared healthcheck registry. All listed deps start unresolved; the gear is not ready until startup is complete, each dep is marked resolved via mark_dep_resolved, and the healthchecks pass. Uses DEFAULT_HEALTHCHECK_TIMEOUT as the per-check timeout.

pub fn with_check_timeout<I, S>( critical_deps: I, healthchecks: Arc<RestHealthcheckRegistry>, check_timeout: Duration, ) -> Arc<Self>

where I: IntoIterator<Item = S>, S: Into<String>,

Like new but with an explicit per-check timeout.

pub fn from_checker( deps: Arc<DependencyChecker>, healthchecks: Arc<RestHealthcheckRegistry>, check_timeout: Duration, ) -> Arc<Self>

Build an aggregator around an existing DependencyChecker, so the in-process consumer-wiring path and the OoP /readyz aggregator share one dependency-resolution core (the checker is fed once, read by both).

pub fn dependency_checker(&self) -> Arc<DependencyChecker>

The shared dependency-resolution core, e.g. to feed it from consumer wiring or to back an in-process ReadinessHealthcheck leaf.

pub fn register_dep(&self, dep_gear: impl Into<String>)

Declare a critical dependency dynamically (idempotent; preserves an already-resolved entry). Complements the up-front critical_deps seed for deps discovered during consumer wiring.

pub fn mark_startup_complete(&self)

Mark startup as complete. Idempotent; subsequent calls are ignored. /readyz will not report Ready or Degraded until this is called.

pub fn is_startup_complete(&self) -> bool

Whether startup is complete.

pub fn mark_dep_resolved(&self, name: &str)

Mark a critical dependency as resolved. Idempotent; unknown names are ignored.

pub fn all_deps_resolved(&self) -> bool

Whether all critical dependencies have been resolved.

pub fn set_draining(&self, draining: bool)

Set (or clear) the draining flag. Setting it flips /readyz to 503 immediately so upstreams pull the instance out of rotation while in-flight requests drain.

pub fn is_draining(&self) -> bool

Whether the gear is currently draining.

pub async fn health_report(&self) -> HealthcheckReport

Run the registered healthchecks and return the aggregated report.

Used by /health to expose full per-component detail and by Self::evaluate to decide readiness state. The registry caches the report, so repeated calls within the cache window do not re-run checks.

pub async fn evaluate(&self) -> ReadinessReport

Evaluate the aggregate readiness.

The gear is ready when it is not draining, startup is complete, all critical deps are resolved, and the aggregated healthcheck report is not Unhealthy. Degraded healthchecks keep the gear ready (state = degraded, ready = true) but the detailed per-component messages belong on /health, not /readyz. The healthcheck fan-out is cached inside the registry, so repeated probe traffic does not re-run checks; dependency and draining state are read live so transitions take effect immediately.

Trait Implementations

impl Debug for ReadinessState

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

Formats the value using the given formatter.