Struct docker_api::docker::Docker [−][src]
pub struct Docker { /* fields omitted */ }
Expand description
Entrypoint interface for communicating with docker daemon
Implementations
Returns the version of Docker that is running and various information about the system that Docker is running on.
Returns system information about Docker instance that is running
This is a dummy endpoint you can use to test if the server is accessible
Returns a stream of Docker events
Returns data usage of this Docker instance
Creates a new Docker instance by automatically choosing appropriate connection type based
on provided uri
.
Supported schemes are:
unix://
only works when build target isunix
, otherwise returns an Errortcp://
http://
To create a Docker instance utilizing TLS use explicit Docker::tls
constructor (this requires tls
feature enabled).
Uses LATEST_API_VERSION
, to use a specific version see
Docker::new_versioned
.
pub fn new_versioned<U>(
uri: U,
version: impl Into<ApiVersion>
) -> Result<Docker> where
U: AsRef<str>,
pub fn new_versioned<U>(
uri: U,
version: impl Into<ApiVersion>
) -> Result<Docker> where
U: AsRef<str>,
Same as Docker::new
but the API version can be explicitly specified.
This is supported on Unix only.
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”.
Uses LATEST_API_VERSION
, to use a specific version see
Docker::unix_versioned
.
pub fn unix_versioned<P>(
socket_path: P,
version: impl Into<ApiVersion>
) -> Docker where
P: AsRef<Path>,
pub fn unix_versioned<P>(
socket_path: P,
version: impl Into<ApiVersion>
) -> Docker where
P: AsRef<Path>,
Same as Docker::unix
but the API version can be explicitly specified.
pub fn tls<H, P>(host: H, cert_path: P, verify: bool) -> Result<Docker> where
H: AsRef<str>,
P: AsRef<Path>,
This is supported on crate feature tls
only.
pub fn tls<H, P>(host: H, cert_path: P, verify: bool) -> Result<Docker> where
H: AsRef<str>,
P: AsRef<Path>,
tls
only.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.
Returns an error if the provided host will fail to parse as URL or reading the certificate files will fail.
Uses LATEST_API_VERSION
, to use a specific version see
Docker::tls_versioned
.
pub fn tls_versioned<H, P>(
host: H,
version: impl Into<ApiVersion>,
cert_path: P,
verify: bool
) -> Result<Docker> where
H: AsRef<str>,
P: AsRef<Path>,
This is supported on crate feature tls
only.
pub fn tls_versioned<H, P>(
host: H,
version: impl Into<ApiVersion>,
cert_path: P,
verify: bool
) -> Result<Docker> where
H: AsRef<str>,
P: AsRef<Path>,
tls
only.Same as Docker::tls
but the API version can be explicitly specified.
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.
Uses LATEST_API_VERSION
, to use a specific version see
Docker::tcp_versioned
.
pub fn tcp_versioned<H>(
host: H,
version: impl Into<ApiVersion>
) -> Result<Docker> where
H: AsRef<str>,
pub fn tcp_versioned<H>(
host: H,
version: impl Into<ApiVersion>
) -> Result<Docker> where
H: AsRef<str>,
Same as Docker::tcp
but the API version can be explicitly specified.
Exports an interface for interacting with Docker containers
Exports an interface for interacting with Docker networks
Verifies the API version returned by the server and adjusts the version used by this client in future requests.
Exports an interface for interacting with Docker services.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Docker
impl !UnwindSafe for Docker
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more