rusty_s3/actions/multipart_upload/
abort.rs

1use std::iter;
2use std::time::Duration;
3
4use jiff::Timestamp;
5use url::Url;
6
7use crate::actions::Method;
8use crate::actions::S3Action;
9use crate::signing::sign;
10use crate::sorting_iter::SortingIterator;
11use crate::{Bucket, Credentials, Map};
12
13/// Abort multipart upload.
14///
15/// This also cleans up any previously uploaded part.
16///
17/// Find out more about `AbortMultipartUpload` from the [AWS API Reference][api]
18///
19/// [api]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
20#[allow(clippy::module_name_repetitions)]
21#[derive(Debug, Clone)]
22pub struct AbortMultipartUpload<'a> {
23    bucket: &'a Bucket,
24    credentials: Option<&'a Credentials>,
25    object: &'a str,
26
27    upload_id: &'a str,
28
29    query: Map<'a>,
30    headers: Map<'a>,
31}
32
33impl<'a> AbortMultipartUpload<'a> {
34    #[inline]
35    #[must_use]
36    pub const fn new(
37        bucket: &'a Bucket,
38        credentials: Option<&'a Credentials>,
39        object: &'a str,
40        upload_id: &'a str,
41    ) -> Self {
42        Self {
43            bucket,
44            credentials,
45            object,
46
47            upload_id,
48
49            query: Map::new(),
50            headers: Map::new(),
51        }
52    }
53}
54
55impl<'a> S3Action<'a> for AbortMultipartUpload<'a> {
56    const METHOD: Method = Method::Delete;
57
58    fn query_mut(&mut self) -> &mut Map<'a> {
59        &mut self.query
60    }
61
62    fn headers_mut(&mut self) -> &mut Map<'a> {
63        &mut self.headers
64    }
65
66    fn sign_with_time(&self, expires_in: Duration, time: &Timestamp) -> Url {
67        let url = self.bucket.object_url(self.object).unwrap();
68        let query = iter::once(("uploadId", self.upload_id));
69
70        match self.credentials {
71            Some(credentials) => sign(
72                time,
73                Self::METHOD,
74                url,
75                credentials.key(),
76                credentials.secret(),
77                credentials.token(),
78                self.bucket.region(),
79                expires_in.as_secs(),
80                SortingIterator::new(query, self.query.iter()),
81                self.headers.iter(),
82            ),
83            None => crate::signing::util::add_query_params(url, query),
84        }
85    }
86}
87
88#[cfg(test)]
89mod tests {
90    use pretty_assertions::assert_eq;
91
92    use super::*;
93    use crate::{Bucket, Credentials, UrlStyle};
94
95    #[test]
96    fn aws_example() {
97        // Fri, 24 May 2013 00:00:00 GMT
98        let date = Timestamp::from_second(1369353600).unwrap();
99        let expires_in = Duration::from_secs(86400);
100
101        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
102        let bucket = Bucket::new(
103            endpoint,
104            UrlStyle::VirtualHost,
105            "examplebucket",
106            "us-east-1",
107        )
108        .unwrap();
109        let credentials = Credentials::new(
110            "AKIAIOSFODNN7EXAMPLE",
111            "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
112        );
113
114        let action = AbortMultipartUpload::new(&bucket, Some(&credentials), "test.txt", "abcd");
115
116        let url = action.sign_with_time(expires_in, &date);
117        let expected = "https://examplebucket.s3.amazonaws.com/test.txt?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20130524%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20130524T000000Z&X-Amz-Expires=86400&X-Amz-SignedHeaders=host&uploadId=abcd&X-Amz-Signature=7670bc768a7cdb5c276a9dddadeefdffb52061f94db6c14b4a9284fdc195bb59";
118
119        assert_eq!(expected, url.as_str());
120    }
121
122    #[test]
123    fn anonymous_custom_query() {
124        let expires_in = Duration::from_secs(86400);
125
126        let endpoint = "https://s3.amazonaws.com".parse().unwrap();
127        let bucket = Bucket::new(
128            endpoint,
129            UrlStyle::VirtualHost,
130            "examplebucket",
131            "us-east-1",
132        )
133        .unwrap();
134
135        let action = AbortMultipartUpload::new(&bucket, None, "test.txt", "abcd");
136        let url = action.sign(expires_in);
137        let expected = "https://examplebucket.s3.amazonaws.com/test.txt?uploadId=abcd";
138
139        assert_eq!(expected, url.as_str());
140    }
141}
rusty_s3/actions/multipart_upload/abort.rs

rusty_s3/actions/multipart_upload/
abort.rs
