From 9adc7b2a3068d2ca432a52474987853ad443bf24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?F=C3=A9mLol=20St=C3=BAdi=C3=B3?= Date: Sun, 11 Feb 2024 02:24:25 +0100 Subject: [PATCH] updating infos --- README.md | 135 +------------------------------------------ aws-creds/Cargo.toml | 4 +- s3/Cargo.toml | 4 +- s3/README.md | 134 +++++++++++++++++++++++++++++++++++++++++- 4 files changed, 138 insertions(+), 139 deletions(-) diff --git a/README.md b/README.md index 63976a68fe..725ba50b50 100644 --- a/README.md +++ b/README.md @@ -1,134 +1 @@ -[![Rust Community](https://img.shields.io/badge/Rust_Community%20-Join_us-brightgreen?style=plastic&logo=rust)](https://www.rust-lang.org/community) -[![build](https://github.com/FemLolStudio/s3-tokio/workflows/build/badge.svg)](https://github.com/FemLolStudio/s3-tokio/actions) -[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/FemLolStudio/s3-tokio/blob/master/LICENSE.md) - - -# s3-tokio [docs](https://docs.rs/rust-s3-async/latest/s3/) - -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](https://github.com/aalekhpatel07/rust-s3-async)*(what is fork of [rust-s3](https://github.com/durch/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. - -```bash -# 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 - -| | | -|----------|-----------------------------------------------------------------------------------------| -| `create` | [async](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.create) | -| `delete` | [async](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.delete) | -| `list` | [async](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.list_buckets)| -| `exists` | [async](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.exists)| - - -### Presign - -| | | -|----------|-----------------------------------------------------------------------------------------------------| -| `POST` | [presign_put](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.presign_post) | -| `PUT` | [presign_put](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.presign_put) | -| `GET` | [presign_get](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.presign_get) | -| `DELETE` | [presign_delete](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.presign_delete) | - -### GET - -There are a few different options for getting an object and methods are generic over `tokio::io::AsyncWriteExt`. - -| | | -|-----------------------------|-----------------------------------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [get_object](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.get_object) | -| `async/sync/async-blocking` | [get_object_stream](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.get_object_stream) | -| `async/sync/async-blocking` | [get_object_to_writer](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.get_object_to_writer) | - -### PUT - -Each `GET` method has a `PUT` companion, and `tokio` methods are generic over `tokio::io::AsyncReadExt`. - -| | | -|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [put_object](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.put_object) | -| `async/sync/async-blocking` | [put_object_with_content_type](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.put_object_with_content_type) | -| `async/sync/async-blocking` | [put_object_stream](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.put_object_stream) | - -### List - -| | | -|-----------------------------|---------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [list](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.list) | - -### DELETE - -| | | -|-----------------------------|---------------------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [delete_object](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.delete_object) | - -### Location - -| | | -|-----------------------------|-----------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [location](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.location) | - -### Tagging - -| | | -|-----------------------------|-------------------------------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [put_object_tagging](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.put_object_tagging) | -| `async/sync/async-blocking` | [get_object_tagging](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.get_object_tagging) | - -### Head - -| | | -|-----------------------------|-----------------------------------------------------------------------------------------------| -| `async/sync/async-blocking` | [head_object](https://docs.rs/rust-s3-async/latest/s3/bucket/struct.Bucket.html#method.head_object) | - -## Usage (in `Cargo.toml`) - -```toml -[dependencies] -rust-s3-async = "0.34.0" -``` - +s3/README.md \ No newline at end of file diff --git a/aws-creds/Cargo.toml b/aws-creds/Cargo.toml index 88486b6bf6..a232184d5e 100644 --- a/aws-creds/Cargo.toml +++ b/aws-creds/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "femlol-aws-creds" -version = "0.37.0" +version = "0.37.1" authors = ["FémLol Stúdió ", "Drazen Urch"] description = "Tiny Rust library for working with Amazon IAM credential,s, supports `s3` crate" repository = "https://github.com/FemLolStudio/s3-tokio" readme = "README.md" keywords = ["AWS", "S3", "Wasabi", "Minio", "R2"] license = "MIT" -# documentation = "https://docs.rs/aws-creds/latest/awscreds/" +documentation = "https://docs.rs/femlol-aws-creds/latest/awscreds/" edition = "2018" [lib] diff --git a/s3/Cargo.toml b/s3/Cargo.toml index b59e8936f8..e412d3f2dc 100644 --- a/s3/Cargo.toml +++ b/s3/Cargo.toml @@ -1,13 +1,13 @@ [package] name = "s3-tokio" -version = "0.37.0" +version = "0.37.1" authors = ["FémLol Stúdió ", "Aalekh Patel ", "Drazen Urch"] description = "Rust library for working with AWS S3 and compatible object storage APIs" repository = "https://github.com/FemLolStudio/s3-tokio" readme = "README.md" keywords = ["S3", "Wasabi", "Minio", "GCP", "R2"] license = "MIT" -# documentation = "" +documentation = "https://docs.rs/s3-tokio/latest/s3/" edition = "2021" [lib] diff --git a/s3/README.md b/s3/README.md index 32d46ee883..387ad47381 120000 --- a/s3/README.md +++ b/s3/README.md @@ -1 +1,133 @@ -../README.md \ No newline at end of file +[![build](https://github.com/FemLolStudio/s3-tokio/workflows/build/badge.svg)](https://github.com/FemLolStudio/s3-tokio/actions) +[![](https://img.shields.io/crates/v/s3-tokio.svg)](https://crates.io/crates/s3-tokio) +![](https://img.shields.io/crates/d/s3-tokio.svg) +[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/FemLolStudio/s3-tokio/blob/master/LICENSE.md) + +# s3-tokio [docs](https://docs.rs/s3-tokio/latest/s3/) + +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](https://github.com/aalekhpatel07/rust-s3-async)*(what is fork of [rust-s3](https://github.com/durch/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. + +```bash +# 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 + +| | | +|----------|-----------------------------------------------------------------------------------------| +| `create` | [async](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.create) | +| `delete` | [async](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.delete) | +| `list` | [async](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.list_buckets)| +| `exists` | [async](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.exists)| + + +### Presign + +| | | +|----------|-----------------------------------------------------------------------------------------------------| +| `POST` | [presign_put](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.presign_post) | +| `PUT` | [presign_put](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.presign_put) | +| `GET` | [presign_get](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.presign_get) | +| `DELETE` | [presign_delete](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.presign_delete) | + +### GET + +There are a few different options for getting an object and methods are generic over `tokio::io::AsyncWriteExt`. + +| | | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [get_object](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.get_object) | +| `async/sync/async-blocking` | [get_object_stream](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.get_object_stream) | +| `async/sync/async-blocking` | [get_object_to_writer](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.get_object_to_writer) | + +### PUT + +Each `GET` method has a `PUT` companion, and `tokio` methods are generic over `tokio::io::AsyncReadExt`. + +| | | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [put_object](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.put_object) | +| `async/sync/async-blocking` | [put_object_with_content_type](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.put_object_with_content_type) | +| `async/sync/async-blocking` | [put_object_stream](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.put_object_stream) | + +### List + +| | | +|-----------------------------|---------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [list](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.list) | + +### DELETE + +| | | +|-----------------------------|---------------------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [delete_object](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.delete_object) | + +### Location + +| | | +|-----------------------------|-----------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [location](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.location) | + +### Tagging + +| | | +|-----------------------------|-------------------------------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [put_object_tagging](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.put_object_tagging) | +| `async/sync/async-blocking` | [get_object_tagging](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.get_object_tagging) | + +### Head + +| | | +|-----------------------------|-----------------------------------------------------------------------------------------------| +| `async/sync/async-blocking` | [head_object](https://docs.rs/s3-tokio/latest/s3/bucket/struct.Bucket.html#method.head_object) | + +## Usage (in `Cargo.toml`) + +```toml +[dependencies] +rust-s3-async = "0.34.0" +``` +