rs_docker_api_rs/api/
system.rs

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
use crate::{
    models,
    opts::{EventsOpts, SystemDataUsageOpts},
    Docker, Error, Result,
};
use containers_api::url::construct_ep;
use futures_util::{Stream, TryStreamExt};

use std::{convert::TryFrom, io};

impl Docker {
    api_doc! { System => Version
    |
    /// Returns the version of Docker that is running and various information about the system that Docker is running on.
    pub async fn version(&self) -> Result<rs_docker_api_stubs::models::SystemVersion> {
        self.get_json("/version").await
    }}

    api_doc! { System => Info
    |
    /// Returns system information about Docker instance that is running
    pub async fn info(&self) -> Result<rs_docker_api_stubs::models::SystemInfo> {
        self.get_json("/info").await
    }}

    api_doc! { System => Ping
    |
    /// This is a dummy endpoint you can use to test if the server is accessible
    pub async fn ping(&self) -> Result<models::PingInfo> {
        self.get("/_ping")
            .await
            .and_then(|resp| crate::models::PingInfo::try_from(resp.headers()))
    }}

    api_doc! { System => Events
    |
    /// Returns a stream of Docker events
    pub fn events<'docker>(
        &'docker self,
        opts: &EventsOpts,
    ) -> impl Stream<Item = Result<rs_docker_api_stubs::models::EventMessage>> + Unpin + 'docker {
        let ep = construct_ep("/events", opts.serialize());
        let reader = Box::pin(
            self.get_stream(ep)
                .map_err(|e| io::Error::new(io::ErrorKind::Other, e)),
        )
        .into_async_read();

        Box::pin(
            asynchronous_codec::FramedRead::new(reader, asynchronous_codec::LinesCodec)
                .map_err(Error::IO)
                .and_then(|s: String| async move {
                    serde_json::from_str(&s).map_err(Error::SerdeJsonError)
                }),
        )
    }}

    api_doc! { System => DataUsage
    |
    /// Returns data usage of this Docker instance
    pub async fn data_usage(&self, opts: &SystemDataUsageOpts) -> Result<rs_docker_api_stubs::models::SystemDataUsage200Response> {
        let ep = construct_ep("/system/df", opts.serialize());
        self.get_json(&ep).await
    }}
}