s3-tokio docs

Rust library for working with Amazon S3 or arbitrary S3 compatible APIs, fully compatible with async/await and futures ^0.3.

Only tokio and rustls support.

[!NOTE] This repository is a fork of rust-s3-async(what is fork of rust-s3) but with only tokio and rustls support. Also with updated dependencies. (for example hyper ^1)

Intro

Modest interface towards Amazon S3, as well as S3 compatible object storage APIs such as Backblaze B2, Wasabi, Yandex, Minio, Cloudflare R2 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

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

# minio
# First, start Minio on port 9000.
AWS_ACCESS_KEY_ID="minioadmin" \
AWS_SECRET_ACCESS_KEY="minioadmin" \
    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 - only fail-on-err
• fail-on-err - panic on any error
• no-verify-ssl - disable SSL verification for endpoints, useful for custom regions

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.

Buckets

Presign

GET

There are a few different options for getting an object and methods are generic over tokio::io::AsyncWriteExt.

PUT

Each GET method has a PUT companion, and tokio methods are generic over tokio::io::AsyncReadExt.

List

DELETE

Location

Tagging

Head

Usage (in Cargo.toml)

[dependencies]
s3-tokio = "0.39"