longshoreman 0.1.0

asynchronous Docker client in pure Rust
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

//! Endpoints and objects for juggling Docker containers

use crate::http_client::HttpClient;
use std::sync::Arc;

mod create;
pub use create::{Create, Response as CreateResponse};

mod list;
pub use list::{List, Response as ListResponse};

mod remove;
pub use remove::Remove;

mod inspect;
pub use inspect::{Inspect, Response as InspectResponse, State, Status};

/// A client to the 'containers' subset of Docker API endpoints
#[derive(Debug)]
pub struct Containers {
    http_client: Arc<HttpClient>,
}

impl Containers {
    pub(crate) fn new(http_client: Arc<HttpClient>) -> Self {
        Self { http_client }
    }

    /// List local containers
    #[must_use]
    pub fn list(&self) -> List {
        List::new(&self.http_client)
    }

    /// Create a new Docker container
    #[must_use]
    pub fn create<'a>(&'a self, image: &'a str) -> Create<'a> {
        Create::new(&self.http_client, image)
    }

    /// Remove an existing Docker container
    ///
    /// The 'container' parameter may be a name or an id.
    #[must_use]
    pub fn remove<'a>(&'a self, container: &'a str) -> Remove<'a> {
        Remove::new(&self.http_client, container)
    }

    /// Retrieve details about an existing Docker container
    ///
    /// The 'container' parameter may be a name or an id.
    #[must_use]
    pub fn inspect<'a>(&'a self, container: &'a str) -> Inspect<'a> {
        Inspect::new(&self.http_client, container)
    }
}