pub struct Client { /* private fields */ }Expand description
Transfer manager client for Amazon Simple Storage Service.
Implementations§
Source§impl Client
impl Client
Sourcepub fn shutdown_completion(&self) -> Option<ShutdownCompletion>
pub fn shutdown_completion(&self) -> Option<ShutdownCompletion>
Returns a non-owning observer of managed-runtime shutdown completion.
Returns Some for automatically created and adopted managed runtimes,
and None for caller-owned Tokio execution. Retaining the observer does
not keep this client or its runtime owner alive. Waiting does not request
shutdown: release client clones and transfer ownership first.
Sourcepub fn new(config: Config) -> Client
pub fn new(config: Config) -> Client
Creates a new client from a transfer manager config.
§Panics
Panics when a component the configuration selects cannot be constructed:
- With the automatic memory configuration, the buffer pool cannot be
sized for this machine: the OS page size is unavailable or produces an
unsupported pool layout, or the detected memory is too small to hold
one buffer. An explicitly configured
BufferPoolreports these conditions as errors fromBufferPoolBuilder::buildinstead. - With managed execution, the managed runtime cannot be started, for example because topology discovery fails or a managed thread cannot be created or initialized.
- With managed execution and no HTTP client configured on the S3 configuration, the default HTTP transport cannot be constructed.
Sourcepub fn metrics(&self) -> ClientMetrics
pub fn metrics(&self) -> ClientMetrics
Returns point-in-time operational metrics for this client.
Sourcepub fn upload(&self) -> UploadFluentBuilder
pub fn upload(&self) -> UploadFluentBuilder
Upload a single object to S3.
Constructs a fluent builder for the
Upload operation.
§Examples
use std::error::Error;
use std::path::Path;
use aws_s3_transfer::io::InputStream;
async fn upload_file(
client: &aws_s3_transfer::Client,
path: impl AsRef<Path>
) -> Result<(), Box<dyn Error>> {
let stream = InputStream::from_path(path)?;
let handle = client.upload()
.bucket("my-bucket")
.key("my-key")
.body(stream)
.initiate()?;
// initiate() will return before the transfer is complete.
// Call the `join()` method on the returned handle to drive the transfer to completion.
// The handle also reports status and metrics, adjusts scheduling, and aborts the transfer.
let response = handle.join().await?;
// ... do something with response
Ok(())
}
Sourcepub fn download(&self) -> DownloadFluentBuilder
pub fn download(&self) -> DownloadFluentBuilder
Download a single object from S3.
A single logical request may be split into many concurrent ranged GetObject requests
to improve throughput.
Constructs a fluent builder for the
Download operation.
§Examples
use std::error::Error;
async fn get_object(client: &aws_s3_transfer::Client) -> Result<(), Box<dyn Error>> {
let handle = client
.download()
.bucket("my-bucket")
.key("my-key")
.initiate()?;
// initiate() will return before the transfer is complete.
// Call the `join()` method on the returned handle to drive the transfer to completion.
// The handle also exposes the object metadata and body, reports status and metrics,
// adjusts scheduling and read-ahead, and aborts the transfer.
let response = handle.join().await?;
// ... do something with response
Ok(())
}Sourcepub fn download_objects(&self) -> DownloadObjectsFluentBuilder
pub fn download_objects(&self) -> DownloadObjectsFluentBuilder
Download multiple objects from an Amazon S3 bucket to a local directory
Each object is written at its full key under the destination directory.
The walker’s prefix selects the objects and does not shorten their
paths. See DownloadObjectsInput
for how keys map to paths.
Each object is written to a temporary file beside its destination path
and renamed into place when that object’s download succeeds, replacing
any file already at that path. A successful join means the operating
system accepted every byte of each downloaded object and completed each
rename. The transfer manager does not call sync_data or sync_all on
the files, or synchronize any directory, including the directories it
creates, so success does not promise persistence across a system crash
or power loss.
Constructs a fluent builder for the
DownloadObjects operation.
§Examples
use std::path::PathBuf;
use aws_s3_transfer::error::Error;
use aws_s3_transfer::io::walk::S3Walker;
async fn download_photos(
client: &aws_s3_transfer::Client,
dest: PathBuf
) -> Result<(), Error> {
let handle = client
.download_objects()
.bucket("my-bucket")
.walker(S3Walker::builder().prefix("photos/").build())
.destination(dest)
.initiate()?;
// wait for transfer to complete
handle.join().await?;
Ok(())
}
Sourcepub fn upload_objects(&self) -> UploadObjectsFluentBuilder
pub fn upload_objects(&self) -> UploadObjectsFluentBuilder
Upload multiple objects from a local directory to an Amazon S3 bucket
Constructs a fluent builder for the
UploadObjects operation.
The default walk is not recursive: it uploads the regular files directly
inside the source directory and skips subdirectories. To upload a
directory tree, supply a walker built with
FsWalker::builder().recursive(true),
as in the example below.
Examples
use std::path::Path;
use aws_s3_transfer::error::Error;
use aws_s3_transfer::io::walk::FsWalker;
async fn upload_directory(
client: &aws_s3_transfer::Client,
source: &Path,
) -> Result<(), Error> {
let handle = client
.upload_objects()
.source(source)
.bucket("my-bucket")
.walker(FsWalker::builder().recursive(true).build())
.initiate()?;
// wait for transfer to complete
handle.join().await?;
Ok(())
}
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Client
impl !UnwindSafe for Client
impl Forget for Client
impl Freeze for Client
impl Move for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl UnsafeUnpin for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more