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

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

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.