Skip to content

Latest commit

 

History

History
143 lines (98 loc) · 9.05 KB

README.md

File metadata and controls

143 lines (98 loc) · 9.05 KB
Raw

build MIT licensed

rust-s3 [docs]

Rust library for working with Amazon S3 or arbitrary S3 compatible APIs, fully compatible with async/await and futures ^0.3. All async features can be turned off and sync only implementations can be used. All requests are automatically retried once, can be further modified with a set_retries call.

🙌 Support further maintenance and development

As many have noted my attention to the this library oscialtes, the best way to ensure I keep maintaining and adding features to it is to donate som BTC, or become a sponsor. Thank you for the support!

💰 BTC 👉 bc1q7ukqe09zplg2sltgfrkukghpelfaz7qja8pw6u

Intro

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

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.

Quick Start

[dependencies]
rust-s3 = "0.35"

Read and run examples from the examples folder, make sure you have valid credentials for the variant you're running.

# tokio, default
cargo run --example tokio

# async-std
cargo run --example async-std --no-default-features --features async-std-native-tls

# sync
cargo run --example sync --no-default-features --features sync-native-tls

# minio
cargo run --example minio

# r2
cargo run --example r2

# google cloud
cargo run --example google-cloud

Features

There are a lot of various features that enable a wide variety of use cases, refer to s3/Cargo.toml for an exhaustive list. Below is a table of various useful features as well as a short description for each.

  • default - tokio runtime and a native-tls implementation
  • blocking - generates *_blocking variant of all Bucket methods, otherwise only async versions are available
  • fail-on-err - return Result::Err for HTTP errors
With default-features = false
  • with-async-std - async-std runtime, surf client used
  • sync - no async runtime, attohttpc is used for HTTP requests
  • tags - required for Bucket::get_object_tagging

All runtimes support either native-tls or rustls-tls, there are features for all combinations, refer to s3/Cargo.toml for a complete list.

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. blocking feature will generate a *_blocking variant of all the methods listed below.

Buckets
create async
delete async
list async
exists async

Presign
POST presign_post
PUT presign_put
GET presign_get
DELETE presign_delete

GET

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

PUT

Each GET method has a PUT companion sync and async methods are generic over std::io::Read. async stream methods are generic over futures_io::AsyncReadExt, while tokio methods are generic over tokio::io::AsyncReadExt.
async/sync/async-blocking put_object
async/sync/async-blocking put_object_with_content_type
async/sync/async-blocking put_object_stream

List
async/sync/async-blocking list

DELETE
async/sync/async-blocking delete_object

Location
async/sync/async-blocking location

Tagging
async/sync/async-blocking put_object_tagging
async/sync/async-blocking get_object_tagging

Head
async/sync/async-blocking head_object