ossify 0.4.0

A modern, easy-to-use, and reqwest-powered Rust SDK for Alibaba Cloud Object Storage Service (OSS)
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

//! Shared `<QoSConfiguration>` XML type used by Bucket QoS, Requester QoS,
//! and Resource Pool QoS operations.
//!
//! The base configuration carries six bandwidth fields (Gbit/s, `-1` meaning
//! "no limit", `0` meaning "disabled"). Resource-pool-level requester QoS
//! additionally supports three QPS fields; those are represented as
//! `Option<i64>` so the same struct round-trips both layouts.

use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

/// Root `<QoSConfiguration>` element used by every QoS API.
#[skip_serializing_none]
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "QoSConfiguration", rename_all = "PascalCase")]
pub struct QoSConfiguration {
    /// Total upload bandwidth cap, Gbit/s. `-1` = no limit, `0` = disabled.
    pub total_upload_bandwidth: i64,
    /// Intranet upload bandwidth cap, Gbit/s.
    pub intranet_upload_bandwidth: i64,
    /// Extranet (public internet) upload bandwidth cap, Gbit/s.
    pub extranet_upload_bandwidth: i64,
    /// Total download bandwidth cap, Gbit/s.
    pub total_download_bandwidth: i64,
    /// Intranet download bandwidth cap, Gbit/s.
    pub intranet_download_bandwidth: i64,
    /// Extranet download bandwidth cap, Gbit/s.
    pub extranet_download_bandwidth: i64,

    /// Total QPS cap. Only used for resource-pool-level requester QoS; left
    /// unset for bucket-level operations.
    pub total_qps: Option<i64>,
    /// Intranet QPS cap. Only used for resource-pool-level requester QoS.
    pub intranet_qps: Option<i64>,
    /// Extranet QPS cap. Only used for resource-pool-level requester QoS.
    pub extranet_qps: Option<i64>,
}

impl QoSConfiguration {
    /// Build a bandwidth-only configuration (used by Bucket QoS, bucket-level
    /// Requester QoS, and Bucket-Group QoS).
    pub fn bandwidth(
        total_upload: i64,
        intranet_upload: i64,
        extranet_upload: i64,
        total_download: i64,
        intranet_download: i64,
        extranet_download: i64,
    ) -> Self {
        Self {
            total_upload_bandwidth: total_upload,
            intranet_upload_bandwidth: intranet_upload,
            extranet_upload_bandwidth: extranet_upload,
            total_download_bandwidth: total_download,
            intranet_download_bandwidth: intranet_download,
            extranet_download_bandwidth: extranet_download,
            total_qps: None,
            intranet_qps: None,
            extranet_qps: None,
        }
    }

    /// Attach QPS caps (resource-pool-level requester QoS only).
    pub fn with_qps(mut self, total: i64, intranet: i64, extranet: i64) -> Self {
        self.total_qps = Some(total);
        self.intranet_qps = Some(intranet);
        self.extranet_qps = Some(extranet);
        self
    }
}

/// One `<RequesterQoSInfo>` entry, returned by Get/List requester-QoS APIs
/// at either bucket or resource-pool scope.
#[derive(Debug, Clone, Default, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename = "RequesterQoSInfo", rename_all = "PascalCase")]
pub struct RequesterQoSInfo {
    /// Alibaba Cloud UID of the requester.
    pub requester: String,
    #[serde(rename = "QoSConfiguration")]
    pub qos_configuration: QoSConfiguration,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn bandwidth_only_round_trip() {
        let cfg = QoSConfiguration::bandwidth(10, -1, -1, 10, -1, -1);
        let xml = quick_xml::se::to_string(&cfg).unwrap();
        assert!(xml.contains("<TotalUploadBandwidth>10</TotalUploadBandwidth>"));
        assert!(xml.contains("<ExtranetDownloadBandwidth>-1</ExtranetDownloadBandwidth>"));
        // QPS fields must be skipped when unset.
        assert!(!xml.contains("TotalQps"));
        let back: QoSConfiguration = quick_xml::de::from_str(&xml).unwrap();
        assert_eq!(back, cfg);
    }

    #[test]
    fn with_qps_round_trip() {
        let cfg = QoSConfiguration::bandwidth(10, -1, -1, 10, -1, -1).with_qps(-1, -1, -1);
        let xml = quick_xml::se::to_string(&cfg).unwrap();
        assert!(xml.contains("<TotalQps>-1</TotalQps>"));
        let back: QoSConfiguration = quick_xml::de::from_str(&xml).unwrap();
        assert_eq!(back.total_qps, Some(-1));
        assert_eq!(back.intranet_qps, Some(-1));
        assert_eq!(back.extranet_qps, Some(-1));
    }
}