Struct AsyncMultipartUpload 

pub struct AsyncMultipartUpload<'a> { /* private fields */ }

A implementation of AsyncWrite for S3 objects using multipart uploads. By using multipart uploads constant memory usage can be achieved.

Note

On failure the multipart upload is not aborted. It is up to the caller to call the S3 abortMultipartUpload API when required.

use cobalt_aws::s3::{AsyncMultipartUpload, Client, S3Object};
use cobalt_aws::config::load_from_env;
use futures::AsyncWriteExt;

let shared_config = load_from_env().await.unwrap();
let client = Client::new(&shared_config);
let dst = S3Object::new("my-bucket", "my-key");
let part_size = 5 * 1_048_576;
let mut writer = AsyncMultipartUpload::new(&client, &dst, part_size, None).await.unwrap();
let buffer_len = 6 * 1_048_576;
// Each part is uploaded as it's available
writer.write_all(&vec![0; buffer_len]).await.unwrap();

// The pending parts are uploaded and the multipart upload is completed
// on close.
writer.close().await.unwrap();

Implementations

impl<'a> AsyncMultipartUpload<'a>

pub async fn new( client: &'a Client, dst: &S3Object, part_size: usize, max_uploading_parts: Option<usize>, ) -> Result<AsyncMultipartUpload<'a>>

Create a new AsyncMultipartUpload.

• client - S3 client to use.
• dst - The S3Object to write the object into.
• part_size - How large, in bytes, each part should be. Must be larger than 5MIB and smaller that 5GIB.
• max_uploading_parts - How many parts to upload concurrently, Must be larger than 0 (defaults to 100).

pub async fn from( client: &'a Client, upload_id: String, dst: &S3Object, part_size: usize, max_uploading_parts: Option<usize>, ) -> Result<AsyncMultipartUpload<'a>>

Import an existing AsyncMultipartUpload to continue uploading.

• client - S3 client to use.
• upload_id - The multipart upload ID to resume.
• dst - The S3Object to write the object into.
• part_size - How large, in bytes, each part should be. Must be larger than 5MIB and smaller that 5GIB.
• max_uploading_parts - How many parts to upload concurrently, Must be larger than 0 (defaults to 100).

pub fn get_upload_id(&self) -> &str

Trait Implementations

impl<'a> AsyncWrite for AsyncMultipartUpload<'a>

fn poll_write( self: Pin<&mut AsyncMultipartUpload<'a>>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close<'b>( self: Pin<&'b mut AsyncMultipartUpload<'a>>, cx: &'b mut Context<'_>, ) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<'a> Debug for AsyncMultipartUpload<'a>

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

Formats the value using the given formatter.