1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00

Add Rust in the SDK section (#1471)

New SDK page for the Rust SDK, with a quickstart from
`minio/minio-rs/README.md`

Going with an external link to a generated reference. Will deal with
API.md as we can.
~We may yet get an `API.md`, so this PR is a draft for now.~
This commit is contained in:
Andrea Longo
2025-06-04 08:53:20 -06:00
committed by GitHub
parent 522ccf4c33
commit 6090d389da
3 changed files with 36 additions and 15 deletions

View File

@ -19,6 +19,7 @@ MinIO publishes the following Software Development Kits (SDK):
- :ref:`JavaScript <javascript-sdk>`
- :ref:`Haskell <haskell-sdk>`
- :ref:`C++ <cpp-sdk>`
- :ref:`Rust <rust-sdk>`
.. _go-sdk:
@ -217,26 +218,19 @@ 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``)
-------------------
Rust
----
GitHub: `minio/minio-rs <https://github.com/minio/minio-rs>`__
Latest Version
|rust-sdk-version|
Reference
:doc:`MinIO Rust SDK Reference </developers/rust/minio-rust>`
Reference: `MinIO Rust SDK Reference <https://docs.rs/minio/latest/minio/>`__
Install
To Do
..
Will need to add C++ and Rust to the toctree once released.
Quickstart Guide: :doc:`/developers/rust/minio-rust`
.. toctree::
:titlesonly:
@ -249,3 +243,4 @@ Install
/developers/java/minio-java
/developers/javascript/minio-javascript
/developers/haskell/minio-haskell
/developers/rust/minio-rust

View File

@ -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

View File

@ -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
}