Struct docker_api::docker::Docker

pub struct Docker { /* private fields */ }

Entrypoint interface for communicating with docker daemon

Implementations

impl Docker

pub async fn version(&self) -> Result<SystemVersion>

Api Reference

Returns the version of Docker that is running and various information about the system that Docker is running on.

pub async fn info(&self) -> Result<SystemInfo>

Api Reference

Returns system information about Docker instance that is running

pub async fn ping(&self) -> Result<PingInfo>

Api Reference

This is a dummy endpoint you can use to test if the server is accessible

pub fn events<'docker>(
    &'docker self,
    opts: &EventsOpts
) -> impl Stream<Item = Result<EventMessage>> + Unpin + 'docker

Api Reference

Returns a stream of Docker events

pub async fn data_usage(&self) -> Result<SystemDataUsage200Response>

Api Reference

Returns data usage of this Docker instance

impl Docker

pub fn new<U>(uri: U) -> Result<Docker> where
    U: AsRef<str>, 

Creates a new Docker instance by automatically choosing appropriate connection type based on provided uri.

Supported schemes are:

• unix:// only works when build target is unix, otherwise returns an Error
• tcp://
• http://

To create a Docker instance utilizing TLS use explicit Docker::tls constructor (this requires tls feature enabled).

Uses LATEST_API_VERSION, to use a specific version see Docker::new_versioned.

pub fn new_versioned<U>(uri: U, version: impl Into<ApiVersion>) -> Result<Docker> where
    U: AsRef<str>, 

Same as Docker::new but the API version can be explicitly specified.

pub fn unix<P>(socket_path: P) -> Docker where
    P: AsRef<Path>, 

Available on Unix only.

Creates a new docker instance for a docker host listening on a given Unix socket.

socket_path is the part of URI that comes after the unix://. For example a URI unix:///run/docker.sock has a socket_path == “/run/docker.sock”.

Uses LATEST_API_VERSION, to use a specific version see Docker::unix_versioned.

pub fn unix_versioned<P>(
    socket_path: P,
    version: impl Into<ApiVersion>
) -> Docker where
    P: AsRef<Path>, 

Available on Unix only.

Same as Docker::unix but the API version can be explicitly specified.

pub fn tls<H, P>(host: H, cert_path: P, verify: bool) -> Result<Docker> where
    H: AsRef<str>,
    P: AsRef<Path>, 

Available on crate feature tls only.

Creates a new docker instance for a docker host listening on a given TCP socket host. host is the part of URI that comes after tcp:// or http:// or https:// schemes, also known as authority part.

cert_path specifies the base path in the filesystem containing a certificate (cert.pem) and a key (key.pem) that will be used by the client. If verify is true a CA file will be added (ca.pem) to the connector.

Returns an error if the provided host will fail to parse as URL or reading the certificate files will fail.

Uses LATEST_API_VERSION, to use a specific version see Docker::tls_versioned.

pub fn tls_versioned<H, P>(
    host: H,
    version: impl Into<ApiVersion>,
    cert_path: P,
    verify: bool
) -> Result<Docker> where
    H: AsRef<str>,
    P: AsRef<Path>, 

Available on crate feature tls only.

Same as Docker::tls but the API version can be explicitly specified.

pub fn tcp<H>(host: H) -> Result<Docker> where
    H: AsRef<str>, 

Creates a new docker instance for a docker host listening on a given TCP socket host. host is the part of URI that comes after tcp:// or http:// schemes, also known as authority part.

TLS is supported with feature tls enabled through Docker::tls constructor.

Returns an error if the provided host will fail to parse as URL.

Uses LATEST_API_VERSION, to use a specific version see Docker::tcp_versioned.

pub fn tcp_versioned<H>(
    host: H,
    version: impl Into<ApiVersion>
) -> Result<Docker> where
    H: AsRef<str>, 

Same as Docker::tcp but the API version can be explicitly specified.

pub fn images(&self) -> Images

Exports an interface for interacting with Docker images

pub fn containers(&self) -> Containers

Exports an interface for interacting with Docker containers

pub fn networks(&self) -> Networks

Exports an interface for interacting with Docker networks

pub fn volumes(&self) -> Volumes

Exports an interface for interacting with Docker volumes

pub async fn adjust_api_version(&mut self) -> Result<()>

Verifies the API version returned by the server and adjusts the version used by this client in future requests.

impl Docker

pub fn services(&self) -> Services

Exports an interface for interacting with Docker services.

pub fn configs(&self) -> Configs

Exports an interface for interacting with Docker configs.

pub fn tasks(&self) -> Tasks

Exports an interface for interacting with Docker tasks.

pub fn secrets(&self) -> Secrets

Exports an interface for interacting with Docker secrets.

pub fn swarm(&self) -> Swarm

Exports an interface for interacting with Docker swarm.

pub fn nodes(&self) -> Nodes

Exports an interface for interacting with Docker nodes.

pub fn plugins(&self) -> Plugins

Exports an interface for interacting with Docker plugins.

Trait Implementations

impl Clone for Docker

fn clone(&self) -> Docker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Docker

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

Formats the value using the given formatter.