Adding `minio` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add minio

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

minio = "0.4.0"

The minio library will be automatically available globally. Read the minio library documentation.

Back to the crate overview.

Readme

MinIO Rust SDK for Amazon S3 Compatible Cloud Storage

The MinIO Rust SDK is a Simple Storage Service (aka S3) client for performing bucket and object operations to any Amazon S3 compatible object storage service. It provides a strongly-typed, async-first interface to the MinIO and Amazon S3-compatible object storage APIs.

Each supported S3 operation has a corresponding request builder (for example: BucketExists, PutObject, UploadPartCopy), which allows users to configure request parameters using a fluent builder pattern.

All request builders implement the S3Api trait, which provides the async send method to execute the request and return a typed response.

Basic Usage

use minio::s3::MinioClient;
use minio::s3::creds::StaticProvider;
use minio::s3::http::BaseUrl;
use minio::s3::types::S3Api;
use minio::s3::response::BucketExistsResponse;

#[tokio::main]
async fn main() {
    let base_url = "http://localhost:9000".parse::<BaseUrl>().unwrap();
    let static_provider = StaticProvider::new("minioadmin", "minioadmin", None);
    let client = MinioClient::new(base_url, Some(static_provider), None, None).unwrap();

    let exists: BucketExistsResponse = client
        .bucket_exists("my-bucket")
        .send()
        .await
        .expect("request failed");

    println!("Bucket exists: {}", exists.exists);
}

Features

Request builder pattern for ergonomic API usage
Full async/await support via tokio
Strongly-typed responses
Transparent error handling via Result<T, Error>

Design

Each API method on the MinioClient returns a builder struct
Builders implement ToS3Request for request conversion and S3Api for execution
Responses implement FromS3Response for consistent deserialization

Examples

You can run the examples from the command line with:

cargo run --example <example_name>

The examples below cover several common operations. You can find the complete list of examples in the examples directory.

file_uploader.rs

file_downloader.rs

Download a file from MinIO

object_prompt.rs

Prompt a file on MinIO

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Adding minio library as a dependency

Adding `minio` library as a dependency