rclone-sdk 1.75.0

Full OpenAPI-based client for the Rclone RC 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
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

//! Hand-written overrides for the generated client. Survives regeneration; the
//! gen script wires it in via `pub mod overrides;`.

use crate::types;
use crate::Client;
use progenitor_client::{Error, ResponseValue};

/// Interactive step from `config/create` / `config/update` (with `opt.nonInteractive`).
#[derive(::serde::Serialize, ::serde::Deserialize, Debug, Clone, Default)]
pub struct ConfigStep {
    #[serde(rename = "State", default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(rename = "Option", default, skip_serializing_if = "Option::is_none")]
    pub option: Option<::serde_json::Value>,
    #[serde(rename = "Error", default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
    #[serde(rename = "Result", default, skip_serializing_if = "Option::is_none")]
    pub result: Option<String>,
    #[serde(flatten)]
    pub extra: ::serde_json::Map<String, ::serde_json::Value>,
}

/// Job handle from an async submission (poll `job/status` with `jobid`).
#[derive(::serde::Serialize, ::serde::Deserialize, Debug, Clone, Default)]
pub struct AsyncJob {
    pub jobid: i64,
}

impl Client {
    /// Typed `config/create` (use with `opt.nonInteractive=true`); preserves the
    /// interactive step fields the generated method drops.
    pub async fn config_create_step<'a>(
        &'a self,
        name: Option<&'a str>,
        type_: Option<&'a str>,
        opt: Option<&'a str>,
        parameters: Option<&'a str>,
    ) -> Result<ResponseValue<ConfigStep>, Error<types::RcError>> {
        self.config_step("config/create", name, type_, opt, parameters)
            .await
    }

    /// Typed `config/update` counterpart of [`Client::config_create_step`].
    pub async fn config_update_step<'a>(
        &'a self,
        name: Option<&'a str>,
        opt: Option<&'a str>,
        parameters: Option<&'a str>,
    ) -> Result<ResponseValue<ConfigStep>, Error<types::RcError>> {
        self.config_step("config/update", name, None, opt, parameters)
            .await
    }

    async fn config_step<'a>(
        &'a self,
        path: &'a str,
        name: Option<&'a str>,
        type_: Option<&'a str>,
        opt: Option<&'a str>,
        parameters: Option<&'a str>,
    ) -> Result<ResponseValue<ConfigStep>, Error<types::RcError>> {
        let url = format!("{}/{}", self.baseurl, path);
        let mut query: Vec<(&str, &str)> = Vec::new();
        if let Some(v) = name {
            query.push(("name", v));
        }
        if let Some(v) = type_ {
            query.push(("type", v));
        }
        if let Some(v) = opt {
            query.push(("opt", v));
        }
        if let Some(v) = parameters {
            query.push(("parameters", v));
        }
        let response = self
            .client
            .post(url)
            .header(::reqwest::header::ACCEPT, "application/json")
            .json(&::serde_json::json!({}))
            .query(&query)
            .send()
            .await?;
        match response.status().as_u16() {
            200 => ResponseValue::from_response(response).await,
            400..=599 => Err(Error::ErrorResponse(
                ResponseValue::from_response(response).await?,
            )),
            _ => Err(Error::UnexpectedResponse(response)),
        }
    }

    /// Submit any RC operation asynchronously (sets `_async=true` +
    /// `Prefer: respond-async`). Rust analog of the TS `ASYNC`.
    pub async fn post_async<'a>(
        &'a self,
        path: &'a str,
        query: &'a [(&'a str, &'a str)],
        body: &'a ::serde_json::Value,
    ) -> Result<ResponseValue<AsyncJob>, Error<types::RcError>> {
        let url = format!("{}/{}", self.baseurl, path.trim_start_matches('/'));
        let mut q: Vec<(&str, &str)> = query.to_vec();
        q.push(("_async", "true"));
        let response = self
            .client
            .post(url)
            .header(::reqwest::header::ACCEPT, "application/json")
            .header("Prefer", "respond-async")
            .json(body)
            .query(&q)
            .send()
            .await?;
        match response.status().as_u16() {
            200 | 202 => ResponseValue::from_response(response).await,
            400..=599 => Err(Error::ErrorResponse(
                ResponseValue::from_response(response).await?,
            )),
            _ => Err(Error::UnexpectedResponse(response)),
        }
    }
}