Struct docker_api::docker::Docker

pub struct Docker { /* fields omitted */ }

Entrypoint interface for communicating with docker daemon

Implementations

impl Docker

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

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<Info>

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<Event>> + Unpin + 'docker

Api Reference

Returns a stream of Docker events

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

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).

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

This is supported 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”.

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

This is supported 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.

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.

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

impl Docker

pub fn services(&self) -> Services<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker services.

pub fn configs(&self) -> Configs<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker configs.

pub fn tasks(&self) -> Tasks<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker tasks.

pub fn secrets(&self) -> Secrets<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker secrets.

pub fn swarm(&self) -> Swarm<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker swarm.

pub fn nodes(&self) -> Nodes<'_>

This is supported on crate feature swarm only.

Exports an interface for interacting with Docker nodes.

pub fn plugins(&self) -> Plugins<'_>

This is supported on crate feature swarm only.

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.