docker_client/
lib.rs

1#![deny(warnings, missing_docs, missing_debug_implementations)]
2//! # docker_client
3//!
4//! `docker_client` is a client that use docker API. Current support API is 1.40.
5//!
6//! # Examples
7//!
8//! ```
9//! use docker_client::DockerClient;
10//! use docker_client::container::Config;
11//!
12//! fn main() {
13//!     // Create docker client
14//!     let client = DockerClient::connect("/var/run/docker.sock");
15//!
16//!     let config = Config::with_image("alpine").name("test").build();
17//!
18//!     // Create container
19//!     match client.create_container(config) {
20//!         Ok(_) => {},
21//!         Err(_) => {}
22//!     };
23//!
24//!     // Rename container
25//!     match client.rename_container("test", "test1") {
26//!         Ok(_) => {},
27//!         Err(_) => {}
28//!     }
29//! }
30//! ```
31
32#[cfg(test)]
33#[macro_use]
34extern crate doc_comment;
35
36#[cfg(test)]
37doctest!("../README.MD", another);
38
39extern crate serde;
40extern crate serde_json;
41extern crate unix_socket;
42extern crate hyper;
43extern crate hyperlocal;
44extern crate futures;
45extern crate tokio;
46extern crate tokio_core;
47
48pub mod container;
49pub mod client;
50pub mod image;
51pub mod volume;
52
53pub use client::DockerError;
54pub use client::DockerClient;
55pub use container::{Config, Killer, Remover};