build MIT licensed

rust-s3 [[docs](https://durch.github.io/rust-s3/s3/)]

Rust library for working with Amazon S3 or arbitrary S3 compatible APIs, fully compatible with async/await and futures ^0.3. Blocking familiy of methods is also compatible with wasm.

Support further development

Intro

Modest interface towards Amazon S3, as well as S3 compatible object storage APIs such as Wasabi, Yandex or Minio. Supports put, get, list, delete, operations on tags and location.

Additionally a dedicated presign_get Bucket method is available. This means you can upload to s3, and give the link to select people without having to worry about publicly accessible files on S3. This also means that you can give people a PUT presigned URL, meaning they can upload to a specific key in S3 for the duration of the presigned URL.

AWS, Yandex and Custom (Minio) Example

Path or subdomain style URLs and headers

Bucket struct provides constructors for path-style paths, subdomain style is the default. Bucket exposes methods for configuring and accessing path-style configuration.

Features

sync and async features are enabled by default. In case you require a different set of features you are probably better off passing in default-features = false, see below. Both sync and async use native-tls as their TLS backend, there are rustls-tls alternative backends available for both of them. rustls-tls features are functionally compatible to their native-tls counterparts, and can be toggled individually or together with the rustls feature. wasm feature is sugar for [sync-rustls]. Useful feature combinations are listed at the bottom of this doc.

Presign

| feature | | |----------------|------------------------------------------------------------------------------------------------| | sync, wasm | presignput | | sync, wasm | presignget |

GET

There are a few different options for getting an object. async and sync methods are generic over std::io::Write, while tokio methods are generic over tokio::io::AsyncWriteExt.

| feature | | |----------------|------------------------------------------------------------------------------------------------------------------------------| | async | getobject | | async | getobjectstream | | sync, wasm | getobjectblocking | | sync, wasm | getobjectstreamblocking | | async | tokiogetobject_stream |

PUT

Each GET method has a PUT companion sync and async methods are generic over std::io::Read, while tokio methods are generic over tokio::io::AsyncReadExt.

| features | | |----------------|------------------------------------------------------------------------------------------------------------------------------| | async | putobject | | async | putobjectstream | | sync, wasm | putobjectblocking | | sync, wasm | putobjectstreamblocking | | async | tokioputobject_stream |

List

| features | | |----------------|----------------------------------------------------------------------------------------------------| | async | list | | sync, wasm | list_blocking |

DELETE

| features | | |----------------|----------------------------------------------------------------------------------------------------------------------| | async | deleteobject | | sync, wasm | deleteobject_blocking |

Location

| features | | |----------------|------------------------------------------------------------------------------------------------------------| | async | location | | sync, wasm | location_blocking |

Tagging

| features | | |----------------|--------------------------------------------------------------------------------------------------------------------------------| | async | putobjecttagging | | sync, wasm | putobjecttaggingblocking | | async | getobjecttagging | | sync, wasm | getobjecttaggingblocking |

Usage (in Cargo.toml)

toml [dependencies] rust-s3 = "0.23"

Features

Disable SSL verification for endpoints, useful for custom regions

```toml

Only available for async feature, as rustls-tls does not support dangereous features ATM

[dependencies] rust-s3 = {version = "0.23", features = ["async", "no-verify-ssl"], default-features = false} ```

Fail on HTTP error responses

toml [dependencies] rust-s3 = {version = "0.23", features = ["fail-on-err"]}

Different SSL backends

Default is native-tls, it is possible to switch to rustls-tls which is more portable

toml [dependencies] rust-s3 = {version = "0.23", features = ["rustls"], default-features = false}

WASM

toml [dependencies] rust-s3 = {version = "0.23", features = ["wasm"], default-features = false}