Struct docker_api::docker::Docker

pub struct Docker { /* fields omitted */ }

Entrypoint interface for communicating with docker daemon

Implementations

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:// with feature unix-socket enabled, otherwise returns an Error
• tcp://
• http://

To create a Docker instance utilizing TLS use explicit Docker::tls constructor.

pub fn unix<P>(socket_path: P) -> Docker where
    P: Into<String>, 

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: Into<String>,
    P: AsRef<Path>, 

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.

pub fn tcp<H>(host: H) -> Docker where
    H: Into<String>, 

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.

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 services(&self) -> Services<'_>

Exports an interface for interacting with Docker services

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 version(&self) -> Result<Version>

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

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/SystemVersion

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

Returns system information about Docker instance that is running

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/SystemInfo

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

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

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/SystemPingHead

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

Returns a stream of docker events

Api Reference: https://docs.docker.com/engine/api/v1.41/#operation/SystemEvents

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.