Struct ListContainersOptions

pub struct ListContainersOptions<T>
where
    T: Into<String> + Eq + Hash + Serialize,
{
    pub all: bool,
    pub limit: Option<isize>,
    pub size: bool,
    pub filters: HashMap<T, Vec<T>>,
}

Parameters used in the List Container API

Examples

use bollard::container::ListContainersOptions;

use std::collections::HashMap;
use std::default::Default;

let mut filters = HashMap::new();
filters.insert("health", vec!["unhealthy"]);

ListContainersOptions{
    all: true,
    filters,
    ..Default::default()
};

ListContainersOptions::<String>{
    ..Default::default()
};

Fields

all: bool

Return all containers. By default, only running containers are shown

limit: Option<isize>

Return this number of most recently created containers, including non-running ones

size: bool

Return the size of container as fields SizeRw and SizeRootFs

filters: HashMap<T, Vec<T>>

Filters to process on the container list, encoded as JSON. Available filters:

• ancestor=(<image-name>[:<tag>], <image id>, or <image@digest>)
• before=(<container id> or <container name>)
• expose=(<port>[/<proto>]|<startport-endport>/[<proto>])
• exited=<int> containers with exit code of <int>
• health=(starting|healthy|unhealthy|none)
• id=<ID> a container’s ID
• isolation=(default|process|hyperv) (Windows daemon only)
• is-task=(true|false)
• label=key or label="key=value" of a container label
• name=<name> a container’s name
• network=(<network id> or <network name>)
• publish=(<port>[/<proto>]|<startport-endport>/[<proto>])
• since=(<container id> or <container name>)
• status=(created|restarting|running|removing|paused|exited|dead)
• volume=(<volume name> or <mount point destination>)

Trait Implementations

impl<T> Clone for ListContainersOptions<T>

where T: Into<String> + Eq + Hash + Serialize + Clone,

fn clone(&self) -> ListContainersOptions<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ListContainersOptions<T>

where T: Into<String> + Eq + Hash + Serialize + Debug,

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

Formats the value using the given formatter.

impl<T> Default for ListContainersOptions<T>

where T: Into<String> + Eq + Hash + Serialize + Default,

fn default() -> ListContainersOptions<T>

Returns the “default value” for a type.

impl<T> PartialEq for ListContainersOptions<T>

where T: Into<String> + Eq + Hash + Serialize + PartialEq,

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

where T: Into<String> + Eq + Hash + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for ListContainersOptions<T>

where T: Into<String> + Eq + Hash + Serialize,