Struct ContainerState

pub struct ContainerState {
    pub dead: Option<bool>,
    pub error: Option<String>,
    pub exit_code: Option<isize>,
    pub finished_at: Option<String>,
    pub health: Option<Health>,
    pub oom_killed: Option<bool>,
    pub paused: Option<bool>,
    pub pid: Option<isize>,
    pub restarting: Option<bool>,
    pub running: Option<bool>,
    pub started_at: Option<String>,
    pub status: Option<String>,
}

ContainerState stores container’s running state. It’s part of ContainerJSONBase and will be returned by the “inspect” command.

Fields

dead: Option<bool>

error: Option<String>

exit_code: Option<isize>

The last exit code of this container

finished_at: Option<String>

The time when this container last exited.

health: Option<Health>

oom_killed: Option<bool>

Whether this container has been killed because it ran out of memory.

paused: Option<bool>

Whether this container is paused.

pid: Option<isize>

The process ID of this container

restarting: Option<bool>

Whether this container is restarting.

running: Option<bool>

Whether this container is running.

Note that a running container can be paused. The Running and Paused booleans are not mutually exclusive:

When pausing a container (on Linux), the freezer cgroup is used to suspend all processes in the container. Freezing the process requires the process to be running. As a result, paused containers are both Running and Paused.

Use the Status field instead to determine if a container’s state is “running”.

started_at: Option<String>

The time when this container was last started.

status: Option<String>

String representation of the container state. Can be one of “created”, “running”, “paused”, “restarting”, “removing”, “exited”, or “dead”.

Trait Implementations

impl Clone for ContainerState

fn clone(&self) -> ContainerState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContainerState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContainerState

fn deserialize<__D>( __deserializer: __D, ) -> Result<ContainerState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContainerState

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContainerState