docktape 0.2.0

Wrapping the Docker API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#![deny(missing_docs)]
#![deny(warnings)]

//! # Docktape
//!
//! Docktape is a wrapper for the Docker API (https://docs.docker.com/develop/sdk/).
//!
//! It currently works with Unix and TCP sockets
//!
//! This crate is currently using Hyper v0.11.27 (https://docs.rs/crate/hyper/0.11.27) and will be updated very soon.

extern crate futures;
extern crate hyper;
#[cfg(not(target_os = "windows"))]
extern crate hyperlocal;
extern crate tokio_core;
extern crate serde_json;
#[macro_use]
extern crate percent_encoding;
#[macro_use]
extern crate log;

mod container;
mod image;
mod network;
mod volume;
#[cfg(not(target_os = "windows"))]
mod unix;
#[cfg(target_os = "windows")]
mod tcp;
mod docker;

pub use futures::Stream;
pub use futures::Future;
pub use hyper::{Client, Result, Request};
pub use tokio_core::reactor::Core;
pub use hyper::Uri;
pub use std::io::{self, Write};
pub use serde_json::Value;
pub use docker::Docker;
pub use hyper::Method;

#[cfg(not(target_os = "windows"))]
pub use unix::{UnixSocket};
#[cfg(not(target_os = "windows"))]
pub use hyperlocal::UnixConnector;
#[cfg(target_os = "windows")]
pub use tcp::{TcpSocket};

/// Trait for both Unix and TCP sockets.
pub trait Socket{
    ///
    fn new(address: &str) -> Self;

    /// Returns the socket address
    fn address(&self) -> String;

    /// Execute a request to the docker API through a socket connection
    fn request(&mut self, uri: Uri, method: Method, body: Option<String>) -> Option<Value>;
}