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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
use crate::bucket::{Bucket, Request};
use crate::command::Command;
use crate::error::S3Error;
use crate::request::RequestImpl;
use crate::request::ResponseData;
use crate::request::{AsyncWrite, ResponseDataStream};
impl Bucket {
/// Gets file from an S3 path.
///
/// # Example:
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
///
/// let response_data = bucket.get_object("/test.file").await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_object<S: AsRef<str>>(&self, path: S) -> Result<ResponseData, S3Error> {
let command = Command::GetObject;
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data(false).await
}
/// Gets torrent from an S3 path.
///
/// # Example:
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
///
/// let response_data = bucket.get_object_torrent("/test.file").await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_object_torrent<S: AsRef<str>>(
&self,
path: S,
) -> Result<ResponseData, S3Error> {
let command = Command::GetObjectTorrent;
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data(false).await
}
/// Gets specified inclusive byte range of file from an S3 path.
///
/// # Example:
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
///
/// let response_data = bucket.get_object_range("/test.file", 0, Some(31)).await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get_object_range<S: AsRef<str>>(
&self,
path: S,
start: u64,
end: Option<u64>,
) -> Result<ResponseData, S3Error> {
if let Some(end) = end {
assert!(start < end);
}
let command = Command::GetObjectRange { start, end };
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data(false).await
}
/// Stream range of bytes from S3 path to a local file, generic over T: Write.
///
/// # Example:
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
/// use std::fs::File;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
/// let mut output_file = File::create("output_file").expect("Unable to create file");
/// let mut async_output_file = tokio::fs::File::create("async_output_file").await.expect("Unable to create file");
/// #[cfg(feature = "with-async-std")]
/// let mut async_output_file = async_std::fs::File::create("async_output_file").await.expect("Unable to create file");
///
/// let start = 0;
/// let end = Some(1024);
///
/// let status_code = bucket.get_object_range_to_writer("/test.file", start, end, &mut async_output_file).await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get_object_range_to_writer<T: AsyncWrite + Send + Unpin, S: AsRef<str>>(
&self,
path: S,
start: u64,
end: Option<u64>,
writer: &mut T,
) -> Result<u16, S3Error> {
if let Some(end) = end {
assert!(start < end);
}
let command = Command::GetObjectRange { start, end };
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data_to_writer(writer).await
}
/// Stream file from S3 path to a local file, generic over T: Write.
///
/// # Example:
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
/// use std::fs::File;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
/// let mut output_file = File::create("output_file").expect("Unable to create file");
/// let mut async_output_file = tokio::fs::File::create("async_output_file").await.expect("Unable to create file");
/// #[cfg(feature = "with-async-std")]
/// let mut async_output_file = async_std::fs::File::create("async_output_file").await.expect("Unable to create file");
///
/// let status_code = bucket.get_object_to_writer("/test.file", &mut async_output_file).await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get_object_to_writer<T: AsyncWrite + Send + Unpin, S: AsRef<str>>(
&self,
path: S,
writer: &mut T,
) -> Result<u16, S3Error> {
let command = Command::GetObject;
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data_to_writer(writer).await
}
/// Stream file from S3 path to a local file using an async stream.
///
/// # Example
///
/// ```rust,no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
/// use tokio_stream::StreamExt;
/// use tokio::io::AsyncWriteExt;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
/// let path = "path";
///
/// let mut response_data_stream = bucket.get_object_stream(path).await?;
///
/// let mut async_output_file = tokio::fs::File::create("async_output_file").await.expect("Unable to create file");
///
/// while let Some(chunk) = response_data_stream.bytes().next().await {
/// async_output_file.write_all(&chunk.unwrap()).await?;
/// }
///
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get_object_stream<S: AsRef<str>>(
&self,
path: S,
) -> Result<ResponseDataStream, S3Error> {
let command = Command::GetObject;
let request = RequestImpl::new(self, path.as_ref(), command)?;
request.response_data_to_stream().await
}
/// Retrieve an S3 object list of tags.
///
/// # Example:
///
/// ```no_run
/// use s3::bucket::Bucket;
/// use s3::creds::Credentials;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
///
/// let bucket_name = "rust-s3-test";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
///
/// let response_data = bucket.get_object_tagging("/test.file").await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn get_object_tagging<S: AsRef<str>>(
&self,
path: S,
) -> Result<(Vec<crate::Tag>, u16), S3Error> {
let command = Command::GetObjectTagging {};
let request = RequestImpl::new(self, path.as_ref(), command)?;
let result = request.response_data(false).await?;
let mut tags = Vec::new();
if result.status_code() == 200 {
let result_string = String::from_utf8_lossy(result.as_slice());
// Add namespace if it doesn't exist
let ns = "http://s3.amazonaws.com/doc/2006-03-01/";
let result_string = if let Err(minidom::Error::MissingNamespace) =
result_string.parse::<minidom::Element>()
{
result_string
.replace("<Tagging>", &format!("<Tagging xmlns=\"{}\">", ns))
.into()
} else {
result_string
};
if let Ok(tagging) = result_string.parse::<minidom::Element>() {
for tag_set in tagging.children() {
if tag_set.is("TagSet", ns) {
for tag in tag_set.children() {
if tag.is("Tag", ns) {
let key = if let Some(element) = tag.get_child("Key", ns) {
element.text()
} else {
"Could not parse Key from Tag".to_string()
};
let value = if let Some(element) = tag.get_child("Value", ns) {
element.text()
} else {
"Could not parse Values from Tag".to_string()
};
tags.push(crate::Tag { key, value });
}
}
}
}
}
}
Ok((tags, result.status_code()))
}
}