Struct longshoreman::Docker

pub struct Docker { /* fields omitted */ }

A Docker client.

The Docker client provides top-level API endpoints, and is used to instantiate the other clients.

Example

use longshoreman::Docker;

let docker_client = Docker::new();

Implementations

impl Docker

#[must_use]pub fn new() -> Docker

constructs a new Docker instance for a docker host listening at a url specified by an env var DOCKER_HOST, falling back to unix:///var/run/docker.sock

pub fn unix(socket_path: impl Into<PathBuf>) -> Docker

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

pub fn host(host: &Uri) -> Docker

constructs a new Docker instance for docker host listening at the given host url

#[must_use]pub fn images(&self) -> Images

Return an Images client.

See the Images client docs for more details

Example

use longshoreman::Docker;

let images = Docker::new().images();

#[must_use]pub fn containers(&self) -> Containers

Return an Containers client.

See the Containers client docs for more details

Example

use longshoreman::Docker;

let containers = Docker::new().containers();

Trait Implementations

impl Debug for Docker

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

Formats the value using the given formatter.

impl Default for Docker

fn default() -> Self

Returns the "default value" for a type.