veltrix 0.6.0

Unix helpers, service integrations, and Unicode metadata
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230

use serde::Deserialize;
use serde_json::Value;
use std::collections::BTreeMap;

/// Docker version information
#[derive(Debug, Clone, Deserialize)]
pub struct DockerVersion {
    #[serde(rename = "Version", default)]
    pub version: Option<String>,

    #[serde(rename = "ApiVersion", default)]
    pub api_version: Option<String>,

    #[serde(rename = "GitCommit", default)]
    pub git_commit: Option<String>,

    #[serde(rename = "GoVersion", default)]
    pub go_version: Option<String>,

    #[serde(rename = "Os", default)]
    pub os: Option<String>,

    #[serde(rename = "Arch", default)]
    pub arch: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker system info
#[derive(Debug, Clone, Deserialize)]
pub struct DockerInfo {
    #[serde(default)]
    pub containers: Option<i64>,

    #[serde(rename = "ContainersRunning", default)]
    pub containers_running: Option<i64>,

    #[serde(rename = "ContainersPaused", default)]
    pub containers_paused: Option<i64>,

    #[serde(rename = "ContainersStopped", default)]
    pub containers_stopped: Option<i64>,

    #[serde(default)]
    pub images: Option<i64>,

    #[serde(default)]
    pub driver: Option<String>,

    #[serde(default)]
    pub version: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker container summary from list operation
#[derive(Debug, Clone, Deserialize)]
pub struct DockerContainerSummary {
    #[serde(rename = "Id", default)]
    pub id: Option<String>,

    #[serde(rename = "Names", default)]
    pub names: Option<Vec<String>>,

    #[serde(rename = "Image", default)]
    pub image: Option<String>,

    #[serde(rename = "ImageID", default)]
    pub image_id: Option<String>,

    #[serde(rename = "Command", default)]
    pub command: Option<String>,

    #[serde(rename = "Created", default)]
    pub created: Option<i64>,

    #[serde(rename = "Ports", default)]
    pub ports: Option<Vec<Value>>,

    #[serde(rename = "Labels", default)]
    pub labels: Option<BTreeMap<String, String>>,

    #[serde(rename = "State", default)]
    pub state: Option<String>,

    #[serde(rename = "Status", default)]
    pub status: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker image summary
#[derive(Debug, Clone, Deserialize)]
pub struct DockerImageSummary {
    #[serde(rename = "Id", default)]
    pub id: Option<String>,

    #[serde(rename = "ParentId", default)]
    pub parent_id: Option<String>,

    #[serde(rename = "RepoTags", default)]
    pub repo_tags: Option<Vec<String>>,

    #[serde(rename = "Created", default)]
    pub created: Option<i64>,

    #[serde(rename = "Size", default)]
    pub size: Option<i64>,

    #[serde(rename = "SharedSize", default)]
    pub shared_size: Option<i64>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker volume summary.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerVolumeSummary {
    #[serde(rename = "Name", default)]
    pub name: Option<String>,

    #[serde(rename = "Driver", default)]
    pub driver: Option<String>,

    #[serde(rename = "Mountpoint", default)]
    pub mountpoint: Option<String>,

    #[serde(rename = "Labels", default)]
    pub labels: Option<BTreeMap<String, String>>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker network summary.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerNetworkSummary {
    #[serde(rename = "Id", alias = "ID", default)]
    pub id: Option<String>,

    #[serde(rename = "Name", default)]
    pub name: Option<String>,

    #[serde(rename = "Driver", default)]
    pub driver: Option<String>,

    #[serde(rename = "Scope", default)]
    pub scope: Option<String>,

    #[serde(rename = "Labels", default)]
    pub labels: Option<BTreeMap<String, String>>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker system disk-usage response.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerSystemDf {
    #[serde(flatten)]
    pub data: BTreeMap<String, Value>,
}

/// Docker container-create response.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerCreateContainerResponse {
    #[serde(rename = "Id", default)]
    pub id: Option<String>,

    #[serde(rename = "Warnings", default)]
    pub warnings: Option<Vec<String>>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Docker image-pull progress line.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerPullImageReport {
    #[serde(default)]
    pub status: Option<String>,

    #[serde(default)]
    pub id: Option<String>,

    #[serde(default)]
    pub progress: Option<String>,

    #[serde(default)]
    pub error: Option<String>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Text output returned by Docker log operations.
#[derive(Debug, Clone)]
pub struct DockerLogs {
    pub output: String,
}

/// Docker Compose service/process summary placeholder for v0.5.0.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerComposeServiceSummary {
    #[serde(rename = "Name", alias = "name", default)]
    pub name: Option<String>,

    #[serde(rename = "Service", alias = "service", default)]
    pub service: Option<String>,

    #[serde(rename = "State", alias = "state", default)]
    pub state: Option<String>,

    #[serde(rename = "Publishers", alias = "publishers", default)]
    pub publishers: Option<Vec<Value>>,

    #[serde(flatten)]
    pub extra: BTreeMap<String, Value>,
}

/// Opaque Docker socket response body for APIs not typed until v0.5.0.
#[derive(Debug, Clone, Deserialize)]
pub struct DockerSocketPayload {
    #[serde(flatten)]
    pub data: BTreeMap<String, Value>,
}