From 86b90236a9faa411ad4d480756ed2cc3507e42df Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 28 May 2025 14:04:19 -0600 Subject: [PATCH 1/3] Add Rust in the SDK section --- source/developers/minio-drivers.rst | 23 ++++++++--------------- source/developers/rust/API.md | 1 + source/developers/rust/minio-rust.rst | 20 ++++++++++++++++++++ source/developers/rust/quickstart.md | 27 +++++++++++++++++++++++++++ sync-docs.sh | 8 +++++++- 5 files changed, 63 insertions(+), 16 deletions(-) create mode 100644 source/developers/rust/API.md create mode 100644 source/developers/rust/minio-rust.rst create mode 100644 source/developers/rust/quickstart.md diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index 4d1ebf590..624d5d0b4 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -19,6 +19,7 @@ MinIO publishes the following Software Development Kits (SDK): - :ref:`JavaScript ` - :ref:`Haskell ` - :ref:`C++ ` +- :ref:`Rust ` .. _go-sdk: @@ -224,26 +225,17 @@ Install cmake --build ./build --config Debug -.. - Rust SDK repo does not have any releases yet. Once released, unblock this section and add to toctree. - .. _rust-sdk: - Rust (``minio-rs``) - ------------------- - - Latest Version - |rust-sdk-version| - - Reference - :doc:`MinIO Rust SDK Reference ` +Rust +---- - Install - To Do +GitHub: `minio/minio-rs `__ +Latest Version + |rust-sdk-version| -.. - Will need to add C++ and Rust to the toctree once released. +Quickstart Guide: :doc:`/developers/rust/minio-rust` .. toctree:: :titlesonly: @@ -256,3 +248,4 @@ Install /developers/java/minio-java /developers/javascript/minio-javascript /developers/haskell/minio-haskell + /developers/rust/minio-rust diff --git a/source/developers/rust/API.md b/source/developers/rust/API.md new file mode 100644 index 000000000..1becba2bb --- /dev/null +++ b/source/developers/rust/API.md @@ -0,0 +1 @@ +404: Not Found \ No newline at end of file diff --git a/source/developers/rust/minio-rust.rst b/source/developers/rust/minio-rust.rst new file mode 100644 index 000000000..16c510234 --- /dev/null +++ b/source/developers/rust/minio-rust.rst @@ -0,0 +1,20 @@ +.. _minio-rust-quickstart: + +===================== +Rust Quickstart Guide +===================== + +.. default-domain:: minio + +.. contents:: Table of Contents + :local: + :depth: 2 + +.. include:: /developers/rust/quickstart.md + :parser: myst_parser.sphinx_ + +.. toctree:: + :titlesonly: + :hidden: + + .. /developers/go/API.md diff --git a/source/developers/rust/quickstart.md b/source/developers/rust/quickstart.md new file mode 100644 index 000000000..5accd94e7 --- /dev/null +++ b/source/developers/rust/quickstart.md @@ -0,0 +1,27 @@ +# MinIO Rust SDK for Amazon S3 Compatible Cloud Storage [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Sourcegraph](https://sourcegraph.com/github.com/minio/minio-rs/-/badge.svg)](https://sourcegraph.com/github.com/minio/minio-rs?badge) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/minio/minio-rs/blob/master/LICENSE) + +MinIO Rust SDK is Simple Storage Service (aka S3) client to perform bucket and object operations to any Amazon S3 compatible object storage service. + +For a complete list of APIs and examples, please take a look at the [MinIO Rust Client API Reference](https://minio-rs.min.io/) + +## Examples + +Run the examples from the command line with: + +`cargo run --example ` + +### file_uploader.rs + +* [Upload a file to MinIO](examples/file_uploader.rs) +* [Upload a file to MinIO with CLI](examples/put_object.rs) + +### file_downloader.rs + +* [Download af file from MinIO](examples/file_downloader.rs) + +### object_prompt.rs + +* [Prompt a file on MinIO](examples/object_prompt.rs) + +## License +This SDK is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see [LICENSE](https://github.com/minio/minio-rs/blob/master/LICENSE) for more information. diff --git a/sync-docs.sh b/sync-docs.sh index 45824b653..3cea12bb7 100755 --- a/sync-docs.sh +++ b/sync-docs.sh @@ -16,7 +16,7 @@ function replace() { function main() { if [ "$#" -eq 0 ]; then - SDKS="dotnet go java js py hs" + SDKS="dotnet go java js py hs rs" fi for sdk in ${SDKS}; do @@ -37,6 +37,9 @@ function main() { "hs") source_dir="haskell" ;; + "rs") + source_dir="rust" # no API.md yet + ;; esac curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md curl --retry 10 -Ls -o source/developers/${source_dir}/quickstart.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/README.md @@ -61,6 +64,9 @@ function main() { "hs") replace HASKELLVERSION ${sdk_version} ;; + "rs") + replace RUSTVERSION ${sdk_version} + ;; esac done } From 8169489041c3f1440d05ee64d108b179bc6fd596 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 28 May 2025 15:27:09 -0600 Subject: [PATCH 2/3] remove unneeded generated files --- source/developers/rust/API.md | 1 - source/developers/rust/quickstart.md | 27 --------------------------- 2 files changed, 28 deletions(-) delete mode 100644 source/developers/rust/API.md delete mode 100644 source/developers/rust/quickstart.md diff --git a/source/developers/rust/API.md b/source/developers/rust/API.md deleted file mode 100644 index 1becba2bb..000000000 --- a/source/developers/rust/API.md +++ /dev/null @@ -1 +0,0 @@ -404: Not Found \ No newline at end of file diff --git a/source/developers/rust/quickstart.md b/source/developers/rust/quickstart.md deleted file mode 100644 index 5accd94e7..000000000 --- a/source/developers/rust/quickstart.md +++ /dev/null @@ -1,27 +0,0 @@ -# MinIO Rust SDK for Amazon S3 Compatible Cloud Storage [![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io) [![Sourcegraph](https://sourcegraph.com/github.com/minio/minio-rs/-/badge.svg)](https://sourcegraph.com/github.com/minio/minio-rs?badge) [![Apache V2 License](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/minio/minio-rs/blob/master/LICENSE) - -MinIO Rust SDK is Simple Storage Service (aka S3) client to perform bucket and object operations to any Amazon S3 compatible object storage service. - -For a complete list of APIs and examples, please take a look at the [MinIO Rust Client API Reference](https://minio-rs.min.io/) - -## Examples - -Run the examples from the command line with: - -`cargo run --example ` - -### file_uploader.rs - -* [Upload a file to MinIO](examples/file_uploader.rs) -* [Upload a file to MinIO with CLI](examples/put_object.rs) - -### file_downloader.rs - -* [Download af file from MinIO](examples/file_downloader.rs) - -### object_prompt.rs - -* [Prompt a file on MinIO](examples/object_prompt.rs) - -## License -This SDK is distributed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0), see [LICENSE](https://github.com/minio/minio-rs/blob/master/LICENSE) for more information. From 26b87d0ae8f81c0b8b1bd839aef06fca99c3cd23 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 4 Jun 2025 07:41:49 -0600 Subject: [PATCH 3/3] link to external generated reference --- source/developers/minio-drivers.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/source/developers/minio-drivers.rst b/source/developers/minio-drivers.rst index 624d5d0b4..be556f7af 100644 --- a/source/developers/minio-drivers.rst +++ b/source/developers/minio-drivers.rst @@ -235,6 +235,8 @@ GitHub: `minio/minio-rs `__ Latest Version |rust-sdk-version| +Reference: `MinIO Rust SDK Reference `__ + Quickstart Guide: :doc:`/developers/rust/minio-rust` .. toctree::