Struct harbourmaster::Client

pub struct Client { /* fields omitted */ }

Docker client

Methods

impl Client

pub fn new() -> Self

Construct a new unique Docker Client. Unless you know you need a unique Client, you should probably use Client::default() which uses a global Docker client internally

Methods from Deref<Target = Docker>

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

pub fn volumes(&self) -> Volumes

pub fn version(&self) -> impl Future<Item = Version, Error = Error>

Returns version information associated with the docker daemon

pub fn info(&self) -> impl Future<Item = Info, Error = Error>

Returns information associated with the docker daemon

pub fn ping(&self) -> impl Future<Item = String, Error = Error>

Returns a simple ping response indicating the docker daemon is accessible

pub fn events(
    &self,
    opts: &EventsOptions
) -> impl Stream<Item = Event, Error = Error>

Returns a stream of docker events

Trait Implementations

impl Default for Client

fn default() -> Self

Construct a new Docker Client. Internally this client uses a globally shared client with a connection pool.

impl From<Docker> for Client

fn from(docker: Docker) -> Self

Create a new Docker Client from a shiplift::Docker object

Example

use harbourmaster::Client;

let client = Client::from(
    shiplift::Docker::new()
);

impl From<Arc<Docker>> for Client

fn from(inner_client: Arc<Docker>) -> Self

Performs the conversion.

impl<'_> From<&'_ Arc<Docker>> for Client

fn from(inner_client: &Arc<Docker>) -> Self

Performs the conversion.

impl<'_> From<&'_ Client> for Client

fn from(client: &Client) -> Self

Performs the conversion.

impl Deref for Client

type Target = Docker

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.