docker-api 0.12.2

Interface to Docker API
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

//! Create and manage persistent storage that can be attached to containers.

use crate::{
    conn::{Headers, Payload},
    models,
    opts::{VolumeCreateOpts, VolumeListOpts, VolumePruneOpts},
    Result,
};

impl_api_ty!(Volume => name);

impl Volume {
    impl_api_ep! {vol: Volume, resp
        Inspect -> &format!("/volumes/{}", vol.name), models::Volume
        Delete -> &format!("/volumes/{}", vol.name), ()
    }
}

impl Volumes {
    impl_api_ep! {__: Volume, resp
        Prune -> "/volumes/prune", models::VolumePrune200Response
    }

    api_doc! { Volume => List
    |
    /// List available volumes
    pub async fn list(&self, opts: &VolumeListOpts) -> Result<models::VolumeList200Response> {
        let ep = containers_api::url::construct_ep("/volumes", opts.serialize());
        self.docker.get_json(&ep).await
    }}

    api_doc! { Volume => Create
    |
    /// Create a new volume.
    pub async fn create(&self, opts: &VolumeCreateOpts) -> Result<models::Volume> {
        // #TODO: handle missing id and return warnings (?)
        self.docker
            .post_json(
                "/volumes/create",
                Payload::Json(opts.serialize()?),
                Headers::none(),
            )
            .await
    }}
}