Skip to content
oksydPublic

About

A lean, modern, unofficial S3-compatible client for Rust.

Topics

Resources

Stars

17 stars

Watchers

2 watching

Forks

Repository files navigation

s3-rs

crates.io docs.rs CI

An unofficial S3-compatible client for Rust, with async and blocking APIs, presigned URLs, and multipart uploads.

API documentation · Feature flags · Examples

Installation

Choose a client mode and TLS backend:

# Async + rustls / ring (default)
cargo add s3

# Async + rustls / Graviola
cargo add s3 --no-default-features --features async-tls-rustls-graviola

# Async + native-tls
cargo add s3 --no-default-features --features async-tls-native

# Blocking + rustls / ring
cargo add s3 --no-default-features --features blocking-tls-rustls-ring

# Blocking + rustls / Graviola
cargo add s3 --no-default-features --features blocking-tls-rustls-graviola

# Blocking + native-tls
cargo add s3 --no-default-features --features blocking-tls-native

# Async and blocking + rustls / ring
cargo add s3 --no-default-features --features async-tls-rustls-ring,blocking-tls-rustls-ring

Each mode enables only its own HTTP client. See feature flags for multipart uploads, checksums, credential providers, tracing, and metrics.

Usage

This example uses the async client and Tokio:

cargo add tokio --features macros,rt-multi-thread
use s3::{Auth, Client};

#[tokio::main]
async fn main() -> s3::Result<()> {
    let client = Client::builder("https://s3.example.com")?
        .region("us-east-1")
        .auth(Auth::from_env()?)
        .build()?;

    let object = client
        .objects()
        .get("my-bucket", "path/to/object.txt")
        .send()
        .await?;
    let bytes = object.bytes().await?;
    println!("{} bytes", bytes.len());
    Ok(())
}

Set your endpoint, region, bucket, and object key. Auth::from_env() reads AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and optionally AWS_SESSION_TOKEN.

See the API documentation for blocking clients, authentication, TLS configuration, and individual operations.

License

Apache-2.0

About

A lean, modern, unofficial S3-compatible client for Rust.

Topics

Resources

Stars

17 stars

Watchers

2 watching

Forks

Releases

Contributors

Languages