Struct ResumableUpload 

pub struct ResumableUpload { /* private fields */ }

A handle bound to one resumable upload session.

See the crate-level documentation for more information and examples on using this API.

Implementations

impl ResumableUpload

pub fn key(&self) -> &str

Returns the object key bound to this upload.

pub fn token(&self) -> &SessionToken

Returns the session token bound to this upload.

pub fn granularity(&self) -> Option<u64>

Returns this upload’s granularity in bytes, if known.

The granularity is the persistence unit for non-final chunks: chunks shorter than one unit are rejected, and larger chunks may persist only an aligned prefix.

pub fn progress(&self) -> UploadProgressBuilder

Builds a request for the server’s authoritative upload progress.

pub fn put(&self, offset: u64, chunk: impl Into<Bytes>) -> PutChunkBuilder

Builds a request to write chunk starting at offset.

put doesn’t perform any automatic compression of the payload, so the caller is responsible for applying compression to the entire payload beforehand and passing chunks of the already compressed payload to this method.

The returned progress contains the authoritative server offset, which should be used for subsequent requests.

pub fn put_stream( &self, offset: u64, length: u64, stream: ClientStream, ) -> PutChunkBuilder

Builds a request to write a streaming chunk of length bytes at offset.

The stream must yield exactly length bytes. If this upload records compression, those bytes must come from the object after it has been compressed in full.

pub fn put_read<R>( &self, offset: u64, length: u64, reader: R, ) -> PutChunkBuilder

where R: AsyncRead + Send + Sync + 'static,

Builds a request to write an [AsyncRead] chunk of length bytes at offset.

The reader must produce exactly length bytes. If this upload records compression, those bytes must come from the object after it has been compressed in full.

pub fn cancel(&self) -> CancelUploadBuilder

Builds a request to cancel this upload session, discarding any uploaded bytes.

Trait Implementations

impl Clone for ResumableUpload

fn clone(&self) -> ResumableUpload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResumableUpload

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

Formats the value using the given formatter.