cloudflare 0.14.0

Rust library for the Cloudflare v4 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

use crate::framework::endpoint::{EndpointSpec, Method, RequestBody};

use crate::endpoints::workerskv::WorkersKvBulkResult;
use crate::framework::response::ApiSuccess;
use serde::{Deserialize, Serialize};

/// Write multiple keys and values at once.
///
/// Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information.
///
/// Existing values and expirations will be overwritten.
/// If neither expiration nor expiration_ttl is specified, the key-value pair will never expire.
/// If both are set, expiration_ttl is used and expiration is ignored.
///
/// The entire request size must be 100 megabytes or less.
///
/// A `404` is returned if a write action is for a namespace ID the account doesn't have.
///
/// <https://developers.cloudflare.com/api/resources/kv/subresources/namespaces/methods/bulk_update/>
#[derive(Debug)]
pub struct WriteBulk<'a> {
    pub account_identifier: &'a str,
    pub namespace_identifier: &'a str,
    pub bulk_key_value_pairs: Vec<KeyValuePair>,
}

impl EndpointSpec for WriteBulk<'_> {
    type JsonResponse = WorkersKvBulkResult;
    type ResponseType = ApiSuccess<Self::JsonResponse>;

    fn method(&self) -> Method {
        Method::PUT
    }
    fn path(&self) -> String {
        format!(
            "accounts/{}/storage/kv/namespaces/{}/bulk",
            self.account_identifier, self.namespace_identifier
        )
    }
    #[inline]
    fn body(&self) -> Option<RequestBody> {
        if self.bulk_key_value_pairs.len() > 10_000 {
            panic!("Bulk write request must have 10,000 key-value pairs or less.");
        }
        // TODO: The entire request size must be 100 megabytes or less.
        let body = serde_json::to_string(&self.bulk_key_value_pairs).unwrap();
        Some(RequestBody::Json(body))
    }
    // default content-type is already application/json
}

// TODO: Does not reflect the API documentation, but having everything Optional doesn't make sense either
#[serde_with::skip_serializing_none]
#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct KeyValuePair {
    pub key: String,
    pub value: String,
    pub expiration: Option<i64>,
    pub expiration_ttl: Option<i64>,
    pub base64: Option<bool>,
}