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
231
232
233
//! Volume API: Create and manage persistent storage that can be attached to containers.
use bytes::Bytes;
use http::request::Builder;
use http_body_util::Full;
use hyper::Method;
use super::Docker;
use crate::docker::BodyType;
use crate::errors::Error;
use crate::models::*;
impl Docker {
/// ---
///
/// # List volumes
///
/// # Arguments
///
/// - [List Volumes Options](crate::query_parameters::ListVolumesOptions) struct.
///
/// # Returns
///
/// - A [Volume List Response]VolumeListResponse) struct, wrapped in a
/// Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// use bollard::query_parameters::ListVolumesOptionsBuilder;
///
/// use std::collections::HashMap;
///
/// let mut filters = HashMap::new();
/// filters.insert("dangling", vec!("1"));
///
/// let options = ListVolumesOptionsBuilder::default().filters(&filters).build();
///
/// docker.list_volumes(Some(options));
/// ```
pub async fn list_volumes(
&self,
options: Option<impl Into<crate::query_parameters::ListVolumesOptions>>,
) -> Result<VolumeListResponse, Error> {
let url = "/volumes";
let req = self.build_request(
url,
Builder::new().method(Method::GET),
options.map(Into::into),
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_value(req).await
}
/// ---
///
/// # Create Volume
///
/// Create a new volume.
///
/// # Arguments
///
/// - [Volume Create Request](VolumeCreateRequest) struct.
///
/// # Returns
///
/// - A [Volume](Volume) struct, wrapped in a
/// Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// use bollard::models::VolumeCreateRequest;
///
/// use std::default::Default;
///
/// let config = VolumeCreateRequest {
/// name: Some(String::from("certs")),
/// ..Default::default()
/// };
///
/// docker.create_volume(config);
/// ```
pub async fn create_volume(
&self,
config: impl Into<VolumeCreateRequest>,
) -> Result<Volume, Error> {
let url = "/volumes/create";
let req = self.build_request(
url,
Builder::new().method(Method::POST),
None::<String>,
Docker::serialize_payload(Some(config.into())),
);
self.process_into_value(req).await
}
/// ---
///
/// # Inspect a Volume
///
/// # Arguments
///
/// - Volume name as a string slice.
///
/// # Returns
///
/// - A [Volume](Volume) struct, wrapped in a
/// Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// docker.inspect_volume("my_volume_name");
/// ```
pub async fn inspect_volume(&self, volume_name: &str) -> Result<Volume, Error> {
let url = format!("/volumes/{volume_name}");
let req = self.build_request(
&url,
Builder::new().method(Method::GET),
None::<String>,
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_value(req).await
}
/// ---
///
/// # Remove a Volume
///
/// # Arguments
///
/// - Volume name as a string slice.
///
/// # Arguments
///
/// - [Remove Volume Options](crate::query_parameters::RemoveVolumeOptions) struct.
///
/// # Returns
///
/// - unit type `()`, wrapped in a Future.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// use bollard::query_parameters::RemoveVolumeOptionsBuilder;
///
/// let options = RemoveVolumeOptionsBuilder::default().force(true).build();
///
/// docker.remove_volume("my_volume_name", Some(options));
/// ```
pub async fn remove_volume(
&self,
volume_name: &str,
options: Option<impl Into<crate::query_parameters::RemoveVolumeOptions>>,
) -> Result<(), Error> {
let url = format!("/volumes/{volume_name}");
let req = self.build_request(
&url,
Builder::new().method(Method::DELETE),
options.map(Into::into),
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_unit(req).await
}
/// ---
///
/// # Prune Volumes
///
/// Delete unused volumes.
///
/// # Arguments
///
/// - A [Prune Volumes Options](crate::query_parameters::PruneVolumesOptions) struct.
///
/// # Returns
///
/// - A [Volume Prune Response](VolumePruneResponse) struct.
///
/// # Examples
///
/// ```rust
/// # use bollard::Docker;
/// # let docker = Docker::connect_with_http_defaults().unwrap();
///
/// use bollard::query_parameters::PruneVolumesOptionsBuilder;
///
/// use std::collections::HashMap;
///
/// let mut filters = HashMap::new();
/// filters.insert("label", vec!["maintainer=some_maintainer"]);
///
/// let options = PruneVolumesOptionsBuilder::default().filters(&filters).build();
///
/// docker.prune_volumes(Some(options));
/// ```
pub async fn prune_volumes(
&self,
options: Option<impl Into<crate::query_parameters::PruneVolumesOptions>>,
) -> Result<VolumePruneResponse, Error> {
let url = "/volumes/prune";
let req = self.build_request(
url,
Builder::new().method(Method::POST),
options.map(Into::into),
Ok(BodyType::Left(Full::new(Bytes::new()))),
);
self.process_into_value(req).await
}
}