Skip to content

Latest commit

 

History

History
138 lines (92 loc) · 6.98 KB

README.md

File metadata and controls

138 lines (92 loc) · 6.98 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

Support further development

  • BTC - 3QQdtQGSMStTWEBhe65hPiAWJekXH8n26o
  • ETH - 0x369Fd06ACc25CCfE0A28BE40018cF3aC38AcdcB6

Intro

Modest interface towards Amazon S3, as well as S3 compatible object storage APIs such as Wasabi, Yandex, Minio or Google Cloud Storage. Supports: put, get, list, delete, operations on tags and location, 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.

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.

Buckets
create async
delete async

Presign
PUT presign_put
GET presign_get

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 get_object
async get_object_stream

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 put_object
async put_object_with_content_type
async put_object_stream

List
async list

DELETE
async delete_object

Location
async location

Tagging
async put_object_tagging
async get_object_tagging

Head
async head_object

Usage (in Cargo.toml)

[dependencies]
rust-s3 = "0.27"

Features

Disable SSL verification for endpoints, useful for custom regions
[dependencies]
rust-s3 = {version = "0.26.0", features = ["no-verify-ssl"]}
Fail on HTTP error responses
[dependencies]
rust-s3 = {version = "0.26.0", features = ["fail-on-err"]}
Different SSL backends

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

[dependencies]
rust-s3 = {version = "0.26.0", features = ["rustls-tls"]}
Use async-std instead of tokio

By default the with-tokio feature is enabled. To switch to async-std you need to disable the default features and specify the with-async-std feature

[dependencies]
rust-s3 = {version = "0.27.0-beta8", features = ["with-async-std"], default-features = false}