Struct Bucket 

pub struct Bucket {
    pub host: Url,
    pub name: String,
    pub region: Region,
    pub credentials: Credentials,
    /* private fields */
}

S3 Bucket operations, your main entrypoint

Fields

host: Url

name: String

region: Region

credentials: Credentials

Implementations

impl Bucket

pub fn new( host: Url, name: String, region: Region, credentials: Credentials, options: Option<BucketOptions>, ) -> Result<Self, S3Error>

pub fn try_from_env() -> Result<Self, S3Error>

pub async fn head<S: AsRef<str>>( &self, path: S, ) -> Result<HeadObjectResult, S3Error>

HEAD information for an object

pub async fn get<P>(&self, path: P) -> Result<S3Response, S3Error>

where P: AsRef<str>,

GET an object

pub async fn get_range<S: AsRef<str>>( &self, path: S, start: u64, end: Option<u64>, ) -> Result<S3Response, S3Error>

pub async fn delete<S: AsRef<str>>( &self, path: S, ) -> Result<S3Response, S3Error>

DELETE an object

pub async fn put<S: AsRef<str>>( &self, path: S, content: &[u8], ) -> Result<S3Response, S3Error>

PUT an object

pub async fn put_with_content_type<S: AsRef<str>>( &self, path: S, content: &[u8], content_type: &str, ) -> Result<S3Response, S3Error>

PUT an object with a specific content type

pub async fn put_with<S: AsRef<str>>( &self, path: S, content: &[u8], extra_headers: HeaderMap, ) -> Result<S3Response, S3Error>

PUT an object with specific headers.

headers accepts additional headers to include in the request. Required headers for the request (i.e. Authorization, Content-Length) don’t need to be included, as they are still handled automatically.

Examples

let bucket = Bucket::try_from_env().await?;
let mut headers = HeaderMap::new();
let content = b"world";

// Denote that this a text file.
headers.insert("Content-Type", "text/plain");
// Tell S3 what the caching behavior this object should respond to clients with.
headers.insert("Cache-Control", "public, max-age=3600");

bucket.put_with("hello.txt", content, headers).await?;

pub async fn put_stream<R>( &self, reader: &mut R, path: String, ) -> Result<PutStreamResponse, S3Error>

where R: AsyncRead + Unpin,

Streaming object upload from any reader that implements AsyncRead

pub async fn put_stream_with_content_type<R>( &self, reader: &mut R, path: String, content_type: String, ) -> Result<PutStreamResponse, S3Error>

where R: AsyncRead + Unpin,

Streaming object upload from any reader that implements AsyncRead

pub async fn put_stream_with<R>( &self, reader: &mut R, path: String, extra_headers: HeaderMap, ) -> Result<PutStreamResponse, S3Error>

where R: AsyncRead + Unpin,

Streaming object upload from any reader that implements AsyncRead.

headers accepts additional headers to include in the request. Required headers for the request (i.e. Authorization, Content-Length) don’t need to be included, as they are still handled automatically.

pub async fn list( &self, prefix: &str, delimiter: Option<&str>, ) -> Result<Vec<ListBucketResult>, S3Error>

List bucket contents

pub async fn copy_internal<F, T>( &self, from: F, to: T, ) -> Result<S3StatusCode, S3Error>

where F: AsRef<str>, T: AsRef<str>,

S3 internal copy an object from one place to another inside the same bucket

pub async fn copy_internal_with<F, T>( &self, from: F, to: T, extra_headers: HeaderMap, ) -> Result<S3StatusCode, S3Error>

where F: AsRef<str>, T: AsRef<str>,

S3 internal copy an object from one place to another inside the same bucket.

headers accepts additional headers to include in the request. Required headers for the request (i.e. Authorization, Content-Length) don’t need to be included, as they are still handled automatically.

Examples

This example shows how to modify the metadata of an existing object in S3.

let bucket = Bucket::try_from_env().await?;
let mut headers = HeaderMap::new();

// `x-amz-metadata-directive` tells S3 what to do with the existing object metadata.
headers.insert("x-amz-metadata-directive", "REPLACE");
headers.insert("Content-Type", "image/jpeg");
headers.insert("Cache-Control", "public, max-age=86400");

bucket.copy_internal_with("cat.jpg", "cat.jpg", headers).await?;

pub async fn copy_internal_from<B, F, T>( &self, from_bucket: B, from_object: F, to: T, ) -> Result<S3StatusCode, S3Error>

where B: AsRef<str>, F: AsRef<str>, T: AsRef<str>,

S3 internal copy an object from another bucket into “this” bucket

Trait Implementations

impl Clone for Bucket

fn clone(&self) -> Bucket

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bucket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.