Struct Client

pub struct Client { /* private fields */ }

Docker client

Implementations

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

Exports an interface for interacting with docker services

pub fn networks(&self) -> Networks<'_>

pub fn volumes(&self) -> Volumes<'_>

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

Returns version information associated with the docker daemon

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

Returns information associated with the docker daemon

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

Returns a simple ping response indicating the docker daemon is accessible

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

Returns a stream of docker events

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

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<&Arc<Docker>> for Client

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

Converts to this type from the input type.

impl From<&Client> for Client

fn from(client: &Client) -> Self

Converts to this type from the input type.

impl From<Arc<Docker>> for Client

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

Converts to this type from the input type.

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 Deref for Client

type Target = Docker

The resulting type after dereferencing.

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

Dereferences the value.