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
use hyper::StatusCode;
use crate::DockerEngineClient;
use crate::errors::DecUseError;
use crate::model::Volume;
pub struct DecVolume<'a> {
pub(super) client: &'a DockerEngineClient,
pub(super) volume_id: String
}
impl <'a> DecVolume<'a> {
/// Get description of an existing volume.
///
/// # Example
///
/// ```rust
/// use passivized_docker_engine_client::DockerEngineClient;
/// use passivized_docker_engine_client::errors::DecError;
///
/// async fn example() -> Result<(), DecError> {
/// let dec = DockerEngineClient::new()?;
///
/// let volume = dec.volume("example").inspect().await?;
///
/// println!("Driver: {}", volume.driver);
///
/// Ok(())
/// }
/// ```
pub async fn inspect(&self) -> Result<Volume, DecUseError> {
let uri = self.client.url.volumes().inspect(&self.volume_id);
let response = self.client.http.get(uri)?.execute().await?;
response
.assert_item_status(StatusCode::OK)?
.parse()
}
/// Remove an existing volume.
///
/// # Arguments
/// * `force` - Remove volume even if it is in use
///
/// # Example
///
/// ```rust
/// use passivized_docker_engine_client::DockerEngineClient;
/// use passivized_docker_engine_client::errors::DecError;
///
/// async fn example() -> Result<(), DecError> {
/// let dec = DockerEngineClient::new()?;
///
/// dec.volume("example").remove(false).await?;
///
/// Ok(())
/// }
/// ```
pub async fn remove(&self, force: bool) -> Result<(), DecUseError> {
let uri = self.client.url.volumes().remove(&self.volume_id, force);
let response = self.client.http.delete(uri)?.execute().await?;
response
.assert_unit_status(StatusCode::NO_CONTENT)
}
}