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
use std::str::FromStr;
use http::HeaderName;
use crate::bucket::*;
use crate::command::Command;
use crate::request::RequestImpl;
impl Bucket {
/// Get path_style field of the Bucket struct
pub fn is_path_style(&self) -> bool {
self.path_style
}
/// Get negated path_style field of the Bucket struct
pub fn is_subdomain_style(&self) -> bool {
!self.path_style
}
/// Configure bucket to use path-style urls and headers
pub fn set_path_style(&mut self) {
self.path_style = true;
}
/// Configure bucket to use subdomain style urls and headers \[default\]
pub fn set_subdomain_style(&mut self) {
self.path_style = false;
}
/// Configure bucket to apply this request timeout to all HTTP
/// requests, or no (infinity) timeout if `None`. Defaults to
/// 30 seconds.
///
/// Only the [`hyper`] backend obeys this option;
/// async code may instead await with a timeout.
pub fn set_request_timeout(&mut self, timeout: Option<Duration>) {
self.request_timeout = timeout;
}
/// Configure bucket to use the older ListObjects API
///
/// If your provider doesn't support the ListObjectsV2 interface, set this to
/// use the v1 ListObjects interface instead. This is currently needed at least
/// for Google Cloud Storage.
pub fn set_listobjects_v1(&mut self) {
self.listobjects_v2 = false;
}
/// Configure bucket to use the newer ListObjectsV2 API
pub fn set_listobjects_v2(&mut self) {
self.listobjects_v2 = true;
}
/// Get a reference to the name of the S3 bucket.
pub fn name(&self) -> String {
self.name.to_string()
}
// Get a reference to the hostname of the S3 API endpoint.
pub fn host(&self) -> String {
if self.path_style {
self.path_style_host()
} else {
self.subdomain_style_host()
}
}
pub fn url(&self) -> String {
if self.path_style {
format!(
"{}://{}/{}",
self.scheme(),
self.path_style_host(),
self.name()
)
} else {
format!("{}://{}", self.scheme(), self.subdomain_style_host())
}
}
/// Get a paths-style reference to the hostname of the S3 API endpoint.
pub fn path_style_host(&self) -> String {
self.region.host()
}
pub fn subdomain_style_host(&self) -> String {
format!("{}.{}", self.name, self.region.host())
}
// pub fn self_host(&self) -> String {
// format!("{}.{}", self.name, self.region.host())
// }
pub fn scheme(&self) -> String {
self.region.scheme()
}
/// Get the region this object will connect to.
pub fn region(&self) -> Region {
self.region.clone()
}
/// Get a reference to the AWS access key.
pub fn access_key(&self) -> Result<Option<String>, S3Error> {
Ok(self
.credentials()
.try_read()
.map_err(|_| S3Error::RLCredentials)?
.access_key
.clone()
.map(|key| key.replace('\n', "")))
}
/// Get a reference to the AWS secret key.
pub fn secret_key(&self) -> Result<Option<String>, S3Error> {
Ok(self
.credentials()
.try_read()
.map_err(|_| S3Error::RLCredentials)?
.secret_key
.clone()
.map(|key| key.replace('\n', "")))
}
/// Get a reference to the AWS security token.
pub fn security_token(&self) -> Result<Option<String>, S3Error> {
Ok(self
.credentials()
.try_read()
.map_err(|_| S3Error::RLCredentials)?
.security_token
.clone())
}
/// Get a reference to the AWS session token.
pub fn session_token(&self) -> Result<Option<String>, S3Error> {
Ok(self
.credentials()
.try_read()
.map_err(|_| S3Error::RLCredentials)?
.session_token
.clone())
}
/// Get a reference to the full [`Credentials`](struct.Credentials.html)
/// object used by this `Bucket`.
pub fn credentials(&self) -> Arc<RwLock<Credentials>> {
self.credentials.clone()
}
/// Change the credentials used by the Bucket.
pub fn set_credentials(&mut self, credentials: Credentials) {
self.credentials = Arc::new(RwLock::new(credentials));
}
/// Add an extra header to send with requests to S3.
///
/// Add an extra header to send with requests. Note that the library
/// already sets a number of headers - headers set with this method will be
/// overridden by the library headers:
/// * Host
/// * Content-Type
/// * Date
/// * Content-Length
/// * Authorization
/// * X-Amz-Content-Sha256
/// * X-Amz-Date
pub fn add_header(&mut self, key: &str, value: &str) {
self.extra_headers
.insert(HeaderName::from_str(key).unwrap(), value.parse().unwrap());
}
/// Get a reference to the extra headers to be passed to the S3 API.
pub fn extra_headers(&self) -> &HeaderMap {
&self.extra_headers
}
/// Get a mutable reference to the extra headers to be passed to the S3
/// API.
pub fn extra_headers_mut(&mut self) -> &mut HeaderMap {
&mut self.extra_headers
}
/// Add an extra query pair to the URL used for S3 API access.
pub fn add_query(&mut self, key: &str, value: &str) {
self.extra_query.insert(key.into(), value.into());
}
/// Get a reference to the extra query pairs to be passed to the S3 API.
pub fn extra_query(&self) -> &Query {
&self.extra_query
}
/// Get a mutable reference to the extra query pairs to be passed to the S3
/// API.
pub fn extra_query_mut(&mut self) -> &mut Query {
&mut self.extra_query
}
pub fn request_timeout(&self) -> Option<Duration> {
self.request_timeout
}
/// Get Bucket location.
///
/// # 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 (region, status_code) = bucket.location().await?;
/// #
/// # Ok(())
/// # }
/// ```
pub async fn location(&self) -> Result<(Region, u16), S3Error> {
let request = RequestImpl::new(self, "?location", Command::GetBucketLocation)?;
let response_data = request.response_data(false).await?;
let region_string = String::from_utf8_lossy(response_data.as_slice());
let region = match quick_xml::de::from_reader(region_string.as_bytes()) {
Ok(r) => {
let location_result: BucketLocationResult = r;
location_result.region.parse()?
}
Err(e) => {
if response_data.status_code() == 200 {
Region::Custom {
region: "Custom".to_string(),
endpoint: "".to_string(),
}
} else {
Region::Custom {
region: format!("Error encountered : {}", e),
endpoint: "".to_string(),
}
}
}
};
Ok((region, response_data.status_code()))
}
}