contain-rs 0.1.3

Run containers with podman (or docker)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//!
//! This module contains the traits that represent the bare functiionality of a client.
//! 
//! See [Podman] for usage of the podman client implementation.
//! 

use std::{
    io::{BufRead, BufReader},
    process::Child,
};

use crate::{
    container::{Container},
    error::Result,
    rt::{ContainerInfo, ProcessState},
};

pub mod docker;
pub mod podman;
pub mod shared;

pub use self::podman::Podman;

///
/// The client Trait represents a way to access a client. 
/// 
/// It's implemented by the [Podman] struct for example. And will be for docker as well.
/// If you do that for any specific Type you get [`handles`](Handle) for free.
/// 
/// 
pub trait Client: Clone {
    type ClientType: Client;

    ///
    /// 
    /// 
    fn create(&self, container: Container) -> ContainerHandle<Self::ClientType>;
    fn run(&self, container: &Container) -> Result<()>;
    fn stop(&self, container: &Container) -> Result<()>;
    fn rm(&self, container: &Container) -> Result<()>;
    fn log(&self, container: &Container) -> Result<Option<Log>>;
    fn inspect(&self, container: &Container) -> Result<Option<ContainerInfo>>;
    fn exists(&self, container: &Container) -> Result<bool>;
    fn runs(&self, container: &Container) -> Result<bool>;
    fn ps(&self) -> Result<Vec<ProcessState>>;
    fn wait(&self, container: &Container) -> Result<()>;
}

///
/// A handle is a way to interact with a container.
/// 
/// When you create a container using a [Client] it will return one of these.
/// The handle automatically stops and removes the container, when it goes out of scope.
/// 
pub trait Handle {
    fn run(&self);
    fn stop(&self);
    fn rm(&self);
    fn log(&self) -> Option<Log>;
    fn container(&self) -> &Container;
    fn is_running(&self) -> bool;
    fn exists(&self) -> bool;
}

pub struct Log {
    pub child: Child,
}

impl Drop for Log {
    fn drop(&mut self) {
        self.child.kill().unwrap();
    }
}

impl Log {
    fn stream(&mut self) -> Option<impl BufRead> {
        self.child
            .stdout
            .take()
            .map(|stdout| BufReader::new(stdout))
    }
}

pub struct ContainerHandle<T: Client> {
    client: T,
    container: Container,
}

impl<T: Client> Handle for ContainerHandle<T> {
    fn run(&self) {
        if !self.is_running() {
            self.client.run(&self.container).unwrap();
            self.client.wait(&self.container).unwrap();
        }
    }

    fn stop(&self) {
        if self.is_running() {
            self.client.stop(&self.container).unwrap()
        }
    }

    fn rm(&self) {
        if self.exists() {
            self.client.rm(&self.container).unwrap()
        }
    }

    fn log(&self) -> Option<Log> {
        if self.is_running() {
            self.client.log(&self.container).unwrap()
        } else {
            None
        }
    }

    fn container(&self) -> &Container {
        &self.container
    }

    fn is_running(&self) -> bool {
        self.exists() && self.client.runs(&self.container).unwrap()
    }

    fn exists(&self) -> bool {
        self.client.exists(&self.container).unwrap()
    }
}

impl<T: Client> Drop for ContainerHandle<T> {
    fn drop(&mut self) {
        self.stop();
        self.rm();
    }
}