Struct Healthcheck 

pub struct Healthcheck {
    pub test: Option<CommandLine>,
    pub http: Option<HttpCheck>,
    pub interval: Option<String>,
    pub timeout: Option<String>,
    pub retries: Option<u32>,
    pub start_period: Option<String>,
}

When a machine counts as healthy, besides its ports answering: a command that succeeds, or a page that answers. Each target waits for it where it waits for the machine (Compose’s depends_on and up --wait, Kubernetes’ readiness, the end of a VM’s set-up).

Fields

test: Option<CommandLine>

A command run inside the machine: healthy when it exits with 0 (exactly one of test and http). The image’s or the VM’s own tools run it (pg_isready, redis-cli ping).

http: Option<HttpCheck>

A page the machine serves: healthy when it answers with a 2xx or 3xx status.

interval: Option<String>

The time between two tries (5s, 1m, 1m30s). Default: 5s.

timeout: Option<String>

How long one try may take before it counts as failed. Default: 3s.

retries: Option<u32>

Failed tries in a row before the machine counts as unhealthy (a VM’s set-up then fails). Default: 60.

start_period: Option<String>

A grace period after start before the first try counts (30s). Default: 10s.

Trait Implementations

impl Clone for Healthcheck

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Healthcheck

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Healthcheck

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Healthcheck

impl JsonSchema for Healthcheck

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 Healthcheck

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Healthcheck

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 Healthcheck