mirror of
https://github.com/minio/minio-rs.git
synced 2025-12-06 15:26:51 +08:00
720943b4bb
* Duplicated code removed, and lazy response evaluation * moved Tokio runtime from general dependency to dev dependency
65 lines
2.4 KiB
Rust
65 lines
2.4 KiB
Rust
// MinIO Rust Library for Amazon S3 Compatible Cloud Storage
|
|
// Copyright 2022 MinIO, Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
//! # MinIO Rust SDK (`minio-rs`)
|
|
//!
|
|
//! This crate 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 (e.g., [`s3::builders::BucketExists`], [`s3::builders::PutObject`], [`s3::builders::UploadPartCopy`]),
|
|
//! which allows users to configure request parameters using a fluent builder pattern.
|
|
//!
|
|
//! All request builders implement the [`s3::types::S3Api`] trait, which provides the async [`send`](crate::s3::types::S3Api::send) method
|
|
//! to execute the request and return a typed response.
|
|
//!
|
|
//! ## Basic Usage
|
|
//!
|
|
//! ```no_run
|
|
//! use minio::s3::Client;
|
|
//! use minio::s3::types::S3Api;
|
|
//! use minio::s3::response::BucketExistsResponse;
|
|
//!
|
|
//! #[tokio::main]
|
|
//! async fn main() {
|
|
//! let client: Client = Default::default(); // configure your client
|
|
//!
|
|
//! 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 [`s3::client::Client`] returns a builder struct
|
|
//! - Builders implement [`s3::types::ToS3Request`] for request conversion and [`s3::types::S3Api`] for execution
|
|
//! - Responses implement [`s3::types::FromS3Response`] for consistent deserialization
|
|
|
|
#![allow(clippy::result_large_err)]
|
|
#![allow(clippy::too_many_arguments)]
|
|
pub mod s3;
|
|
|
|
#[cfg(test)]
|
|
#[macro_use]
|
|
extern crate quickcheck;
|