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
110
111
112
113
114
115
116
117
118
119
120
121

//! PutObjectACL: set the access permissions on an existing object.
//!
//! The ACL is passed via the `x-oss-object-acl` header, not in the body.
//!
//! Official document: <https://www.alibabacloud.com/help/en/oss/developer-reference/putobjectacl>

use std::future::Future;

use http::{HeaderMap, HeaderName, Method};
use serde::Serialize;

use crate::body::ZeroBody;
use crate::error::Result;
use crate::ops::common::ObjectAcl;
use crate::response::EmptyResponseProcessor;
use crate::ser::OnlyKeyField;
use crate::{Client, Ops, Prepared, Request};

/// PutObjectACL query parameters: `?acl[&versionId=<id>]`.
#[derive(Debug, Clone, Default, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PutObjectAclParams {
    pub(crate) acl: OnlyKeyField,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version_id: Option<String>,
}

impl PutObjectAclParams {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn version_id(mut self, v: impl Into<String>) -> Self {
        self.version_id = Some(v.into());
        self
    }
}

/// PutObjectACL operation.
pub struct PutObjectAcl {
    pub object_key: String,
    pub params: PutObjectAclParams,
    pub acl: ObjectAcl,
}

impl Ops for PutObjectAcl {
    type Response = EmptyResponseProcessor;
    type Body = ZeroBody;
    type Query = PutObjectAclParams;

    fn prepare(self) -> Result<Prepared<PutObjectAclParams>> {
        let mut headers = HeaderMap::new();
        headers.insert(HeaderName::from_static("x-oss-object-acl"), self.acl.as_str().parse()?);
        Ok(Prepared {
            method: Method::PUT,
            key: Some(self.object_key),
            query: Some(self.params),
            headers: Some(headers),
            body: Some(()),
            ..Default::default()
        })
    }
}

/// Trait for PutObjectACL operations.
pub trait PutObjectAclOperations {
    /// Set the ACL of an object.
    fn put_object_acl(
        &self,
        object_key: impl Into<String>,
        acl: ObjectAcl,
        params: Option<PutObjectAclParams>,
    ) -> impl Future<Output = Result<()>>;
}

impl PutObjectAclOperations for Client {
    async fn put_object_acl(
        &self,
        object_key: impl Into<String>,
        acl: ObjectAcl,
        params: Option<PutObjectAclParams>,
    ) -> Result<()> {
        let ops = PutObjectAcl {
            object_key: object_key.into(),
            params: params.unwrap_or_default(),
            acl,
        };
        self.request(ops).await
    }
}

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

    #[test]
    fn test_serialize_params_default() {
        let q = crate::ser::to_string(&PutObjectAclParams::default()).unwrap();
        assert_eq!(q, "acl");
    }

    #[test]
    fn test_serialize_params_with_version() {
        let q = crate::ser::to_string(&PutObjectAclParams::new().version_id("v1")).unwrap();
        assert_eq!(q, "acl&versionId=v1");
    }

    #[test]
    fn test_prepare_header() {
        let p = PutObjectAcl {
            object_key: "foo.jpg".into(),
            params: PutObjectAclParams::new(),
            acl: ObjectAcl::PublicRead,
        }
        .prepare()
        .unwrap();
        assert_eq!(p.method, Method::PUT);
        assert_eq!(p.key.as_deref(), Some("foo.jpg"));
        assert_eq!(p.headers.unwrap().get("x-oss-object-acl").unwrap(), "public-read");
    }
}