Struct Readiness 

pub struct Readiness {
    pub ready: bool,
    pub version: String,
    pub commit: String,
    pub dirty: Option<bool>,
    pub capabilities: usize,
    pub objects: usize,
    pub layer: HealthStatus,
    pub stale: Option<String>,
    pub reasons: Vec<String>,
}

The answer to “can this process serve traffic”: the local initialisation a request would need, and nothing beyond this process. A readiness check that grew a dependency probe fails a deployment because an unrelated service is down.

Fields

ready: bool

Whether every part below is in place.

version: String

This executable’s version.

commit: String

The commit this executable was built from, or unknown; the same value health.live answers.

dirty: Option<bool>

Whether the build’s tree was dirty; null when the build did not know.

capabilities: usize

How many capabilities the registry holds; zero would mean nothing to serve.

objects: usize

How many objects the index holds. Read from the index this process built at start-up: it is already in memory, and reading it walks nothing.

layer: HealthStatus

Whether the layer read cleanly. A degraded layer is still served — the diagnostics are the point — so this reports rather than refuses.

stale: Option<String>

Why this process is serving code that is no longer on disk: the executable it was started from has been replaced or removed since. Present, ready is false — a server answering with yesterday’s code says so in the place it says it is ready, to a client holding nothing but this answer (I1502).

reasons: Vec<String>

Every reason this answer is not a plain yes, as code: words. lease_lost and stale make ready false: another process holds this checkout’s lease, or this one serves code that is gone. layer_degraded does not: the layer is served with its diagnostics, and a client decides whether that is enough.

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<'de> Deserialize<'de> for Readiness

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Readiness

impl JsonSchema for Readiness

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 PartialEq for Readiness

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

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 Readiness