Struct DockerCli 

pub struct DockerCli { /* private fields */ }

Runs the docker CLI (with the Compose plugin). It honours DOCKER_HOST and the current Docker context like the CLI does; with_context pins one.

Implementations

impl DockerCli

pub fn new() -> Self

The docker on PATH, under the current context.

pub fn with_program(self, program: impl Into<PathBuf>) -> Self

Run program instead of docker (e.g. an absolute path).

pub fn with_context(self, context: impl Into<String>) -> Self

Talk to the daemon of Docker context context (docker --context <context>).

Trait Implementations

impl Clone for DockerCli

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeEngine for DockerCli

fn up<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dir: &'life1 Path, opts: &'life2 UpOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create and start the project in dir (docker compose up -d).

fn down<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dir: &'life1 Path, opts: &'life2 DownOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Stop and remove the project in dir (docker compose down).

fn ls<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ProjectStatus>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Every project Docker knows of, running or stopped (docker compose ls --all).

fn ps<'life0, 'life1, 'async_trait>( &'life0 self, project: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ServiceStatus>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The containers of project, running or stopped (docker compose ps --all).

fn logs<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, opts: &'life2 LogOptions, ) -> Pin<Box<dyn Future<Output = Result<EngineStream<LogLine>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The log lines of project’s containers (docker compose logs --timestamps).

fn events<'life0, 'life1, 'async_trait>( &'life0 self, filter: &'life1 EventFilter, ) -> Pin<Box<dyn Future<Output = Result<EngineStream<EngineEvent>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Container events of the projects filter picks, from now on (docker events).

fn network_rm<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove the network name; Ok(false) when it doesn’t exist or is still in use.

impl Debug for DockerCli

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

Formats the value using the given formatter.

impl Default for DockerCli

fn default() -> Self

Returns the “default value” for a type.