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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
use crate::bucket::Bucket;
use crate::command::Command;
use crate::error::S3Error;
use crate::request::Request;
use crate::request::RequestImpl;
use crate::serde_types::{ListBucketResult, ListMultipartUploadsResult};
use awscreds::Credentials;
use awsregion::Region;
use serde::Deserialize;
impl Bucket {
/// Get a list of all existing buckets in the region
/// that are accessible by the given credentials.
/// ```no_run
/// use s3::{Bucket, BucketConfiguration};
/// use s3::creds::Credentials;
/// use s3::region::Region;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let region = Region::Custom {
/// region: "eu-central-1".to_owned(),
/// endpoint: "http://localhost:9000".to_owned()
/// };
/// let credentials = Credentials::default()?;
///
/// let response = Bucket::list_buckets(region, credentials).await?;
///
/// let found_buckets = response.bucket_names().collect::<Vec<String>>();
/// println!("found buckets: {:#?}", found_buckets);
/// # Ok(())
/// # }
/// ```
pub async fn list_buckets(
region: Region,
credentials: Credentials,
) -> Result<crate::bucket::ListBucketsResponse, S3Error> {
let dummy_bucket = Bucket::new("", region, credentials)?.with_path_style();
let request = RequestImpl::new(&dummy_bucket, "", Command::ListBuckets)?;
let response = request.response_data(false).await?;
Ok(quick_xml::de::from_str::<crate::bucket::ListBucketsResponse>(response.as_str()?)?)
}
/// Determine whether the instantiated bucket exists.
/// ```no_run
/// use s3::{Bucket, BucketConfiguration};
/// use s3::creds::Credentials;
/// use s3::region::Region;
/// use anyhow::Result;
///
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let bucket_name = "some-bucket-that-is-known-to-exist";
/// let region = "us-east-1".parse()?;
/// let credentials = Credentials::default()?;
///
/// let bucket = Bucket::new(bucket_name, region, credentials)?;
///
/// let exists = bucket.exists().await?;
///
/// assert_eq!(exists, true);
/// # Ok(())
/// # }
/// ```
pub async fn exists(&self) -> Result<bool, S3Error> {
let credentials = self.credentials.read().await.clone();
let response = Self::list_buckets(self.region.clone(), credentials).await?;
Ok(response
.bucket_names()
.collect::<std::collections::HashSet<String>>()
.contains(&self.name))
}
pub async fn list_page(
&self,
prefix: String,
delimiter: Option<String>,
continuation_token: Option<String>,
start_after: Option<String>,
max_keys: Option<usize>,
) -> Result<(ListBucketResult, u16), S3Error> {
let command = if self.listobjects_v2 {
Command::ListObjectsV2 {
prefix,
delimiter,
continuation_token,
start_after,
max_keys,
}
} else {
// In the v1 ListObjects request, there is only one "marker"
// field that serves as both the initial starting position,
// and as the continuation token.
Command::ListObjects {
prefix,
delimiter,
marker: std::cmp::max(continuation_token, start_after),
max_keys,
}
};
let request = RequestImpl::new(self, "/", command)?;
let response_data = request.response_data(false).await?;
let list_bucket_result = quick_xml::de::from_reader(response_data.as_slice())?;
Ok((list_bucket_result, response_data.status_code()))
}
/// List the contents of an S3 bucket.
///
/// # 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 results = bucket.list("/".to_string(), Some("/".to_string())).await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn list(
&self,
prefix: String,
delimiter: Option<String>,
) -> Result<Vec<ListBucketResult>, S3Error> {
let the_bucket = self.to_owned();
let mut results = Vec::new();
let mut continuation_token = None;
loop {
let (list_bucket_result, _) = the_bucket
.list_page(
prefix.clone(),
delimiter.clone(),
continuation_token,
None,
None,
)
.await?;
continuation_token = list_bucket_result.next_continuation_token.clone();
results.push(list_bucket_result);
if continuation_token.is_none() {
break;
}
}
Ok(results)
}
pub async fn list_multiparts_uploads_page(
&self,
prefix: Option<&str>,
delimiter: Option<&str>,
key_marker: Option<String>,
max_uploads: Option<usize>,
) -> Result<(ListMultipartUploadsResult, u16), S3Error> {
let command = Command::ListMultipartUploads {
prefix,
delimiter,
key_marker,
max_uploads,
};
let request = RequestImpl::new(self, "/", command)?;
let response_data = request.response_data(false).await?;
let list_bucket_result = quick_xml::de::from_reader(response_data.as_slice())?;
Ok((list_bucket_result, response_data.status_code()))
}
/// List the ongoing multipart uploads of an S3 bucket. This may be useful to cleanup failed
/// uploads, together with [`crate::bucket::Bucket::abort_upload`].
///
/// # 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 results = bucket.list_multiparts_uploads(Some("/"), Some("/")).await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn list_multiparts_uploads(
&self,
prefix: Option<&str>,
delimiter: Option<&str>,
) -> Result<Vec<ListMultipartUploadsResult>, S3Error> {
let the_bucket = self.to_owned();
let mut results = Vec::new();
let mut next_marker: Option<String> = None;
loop {
let (list_multiparts_uploads_result, _) = the_bucket
.list_multiparts_uploads_page(prefix, delimiter, next_marker, None)
.await?;
let is_truncated = list_multiparts_uploads_result.is_truncated;
next_marker = list_multiparts_uploads_result.next_marker.clone();
results.push(list_multiparts_uploads_result);
if !is_truncated {
break;
}
}
Ok(results)
}
}
#[derive(Clone, Default, Deserialize, Debug)]
#[serde(rename_all = "PascalCase", rename = "ListAllMyBucketsResult")]
pub struct ListBucketsResponse {
pub owner: BucketOwner,
pub buckets: BucketContainer,
}
impl ListBucketsResponse {
pub fn bucket_names(&self) -> impl Iterator<Item = String> + '_ {
self.buckets.bucket.iter().map(|bucket| bucket.name.clone())
}
}
#[derive(Deserialize, Default, Clone, Debug, PartialEq, Eq)]
pub struct BucketOwner {
#[serde(rename = "ID")]
pub id: String,
#[serde(rename = "DisplayName")]
pub display_name: String,
}
#[derive(Deserialize, Default, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct BucketInfo {
pub name: String,
pub creation_date: crate::serde_types::DateTime,
}
#[derive(Deserialize, Default, Clone, Debug)]
#[serde(rename_all = "PascalCase")]
pub struct BucketContainer {
#[serde(default)]
pub bucket: Vec<BucketInfo>,
}
#[cfg(test)]
mod tests {
#[test]
pub fn parse_list_buckets_response() {
let response = r#"
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Owner>
<ID>02d6176db174dc93cb1b899f7c6078f08654445fe8cf1b6ce98d8855f66bdbf4</ID>
<DisplayName>minio</DisplayName>
</Owner>
<Buckets>
<Bucket>
<Name>test-rust-s3</Name>
<CreationDate>2023-06-04T20:13:37.837Z</CreationDate>
</Bucket>
<Bucket>
<Name>test-rust-s3-2</Name>
<CreationDate>2023-06-04T20:17:47.152Z</CreationDate>
</Bucket>
</Buckets>
</ListAllMyBucketsResult>
"#;
let parsed = quick_xml::de::from_str::<super::ListBucketsResponse>(response).unwrap();
assert_eq!(parsed.owner.display_name, "minio");
assert_eq!(
parsed.owner.id,
"02d6176db174dc93cb1b899f7c6078f08654445fe8cf1b6ce98d8855f66bdbf4"
);
assert_eq!(parsed.buckets.bucket.len(), 2);
assert_eq!(parsed.buckets.bucket.first().unwrap().name, "test-rust-s3");
assert_eq!(
parsed.buckets.bucket.first().unwrap().creation_date,
"2023-06-04T20:13:37.837Z"
.parse::<crate::serde_types::DateTime>()
.unwrap()
);
assert_eq!(parsed.buckets.bucket.last().unwrap().name, "test-rust-s3-2");
assert_eq!(
parsed.buckets.bucket.last().unwrap().creation_date,
"2023-06-04T20:17:47.152Z"
.parse::<crate::serde_types::DateTime>()
.unwrap()
);
}
#[test]
pub fn parse_list_buckets_response_when_no_buckets_exist() {
let response = r#"
<?xml version="1.0" encoding="UTF-8"?>
<ListAllMyBucketsResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<Owner>
<ID>02d6176db174dc93cb1b899f7c6078f08654445fe8cf1b6ce98d8855f66bdbf4</ID>
<DisplayName>minio</DisplayName>
</Owner>
<Buckets>
</Buckets>
</ListAllMyBucketsResult>
"#;
let parsed = quick_xml::de::from_str::<super::ListBucketsResponse>(response).unwrap();
assert_eq!(parsed.owner.display_name, "minio");
assert_eq!(
parsed.owner.id,
"02d6176db174dc93cb1b899f7c6078f08654445fe8cf1b6ce98d8855f66bdbf4"
);
assert_eq!(parsed.buckets.bucket.len(), 0);
}
}