Struct Healthcheck 

pub struct Healthcheck {
    pub disable: Option<bool>,
    pub test: Option<StringOrList>,
    pub interval: Option<String>,
    pub start_period: Option<String>,
    pub start_interval: Option<String>,
    pub retries: Option<StringOrNum>,
    pub timeout: Option<String>,
}

Declares a check that’s run to determine whether or not the service containers are “healthy”.

See more: https://docs.docker.com/reference/compose-file/services/#healthcheck

Fields

disable: Option<bool>

Disable any container-specified healthcheck. Set to true to disable.

test: Option<StringOrList>

The test to perform to check container health. Can be a string or a list. The first item is either NONE, CMD, or CMD-SHELL. If it’s CMD, the rest of the command is exec’d. If it’s CMD-SHELL, the rest is run in the shell.

interval: Option<String>

Time between running the check (e.g., ‘1s’, ‘1m30s’). Default: 30s.

start_period: Option<String>

Start period for the container to initialize before starting health-retries countdown (e.g., ‘1s’, ‘1m30s’). Default: 0s.

start_interval: Option<String>

Time between running the check during the start period (e.g., ‘1s’, ‘1m30s’). Default: interval value.

retries: Option<StringOrNum>

Number of consecutive failures needed to consider the container as unhealthy. Default: 3.

timeout: Option<String>

Maximum time to allow one check to run (e.g., ‘1s’, ‘1m30s’). Default: 30s.

Trait Implementations

impl Clone for Healthcheck

fn clone(&self) -> Healthcheck

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 Default for Healthcheck

fn default() -> Healthcheck

Returns the “default value” for a type.

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

where Healthcheck: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Healthcheck

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Healthcheck

impl StructuralPartialEq for Healthcheck