Struct UploadRequest 

#[non_exhaustive]
pub struct UploadRequest {
    pub concurrency_per_file: usize,
    pub dest_bucket: String,
    pub dest_prefix: String,
    pub sources: Vec<PathBuf>,
    pub workers: usize,
    /* private fields */
}

A batch upload request.

Accepts a list of files and/or directories. Directories are walked recursively. All files are uploaded under dest_prefix in dest_bucket, preserving relative paths from the common ancestor of sources.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

concurrency_per_file: usize

Number of parts uploaded concurrently within a single multipart upload.

dest_bucket: String

Target S3 bucket.

dest_prefix: String

Key prefix in the bucket (e.g. data/2024/).

sources: Vec<PathBuf>

Local file or directory paths to upload.

workers: usize

Number of files uploaded in parallel.

Implementations

impl UploadRequest

pub fn file_count(&self) -> Result<usize>

Expand sources and count the total number of files that would be uploaded.

Useful for setting up progress bars before calling S3Client::upload.

Errors

Returns an error if source expansion fails (e.g. non-UTF-8 paths).

pub fn new( sources: Vec<PathBuf>, dest_bucket: impl Into<String>, dest_prefix: impl Into<String>, ) -> Self

Create a new upload request with sensible defaults.

Defaults: 32 workers, 8 concurrent parts per file.

Each part is streamed from disk through a 256 KiB buffer, so peak memory per file is roughly concurrency_per_file * 256 KiB.

Note: actual per-file concurrency is dynamically scaled based on each file’s size.

pub fn on_file_complete( self, callback: impl Fn(&FileUploadResult) + Send + Sync + 'static, ) -> Self

Set a callback that fires after each file upload completes.

The callback receives a reference to the FileUploadResult for the just-completed file. It runs on the tokio worker thread, so keep it lightweight (e.g. update a progress bar).

Trait Implementations

impl Debug for UploadRequest

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

Formats the value using the given formatter.