YDBRust - YottaDB 的 Rust 封装

YottaDB 是一个多语言 NoSQL 数据库。

本包中的所有软件均为 YottaDB 的一部分，每个文件都标明了其版权所有者。软件按照许可证条款向您提供。有关详细信息，请参阅 LICENSE 文件。

主页: https://gitlab.com/YottaDB/Lang/YDBRust

文档: https://yottadb.gitlab.io/Lang/YDBRust/yottadb/

在项目中使用 YDBRust

在 Cargo.toml 中包含 YDBRust

[dependencies]
yottadb = "1.0"

在构建或使用依赖于 YottaDB 的项目之前，您需要

1. 确保 YottaDB 已设置并配置。

   source $(pkg-config --variable=prefix yottadb)/ydb_env_set
   

2. 确保 rust 和 cargo 已设置并配置。

查看 examples/ 获取 API 使用示例，或查看文档以获取完整参考。

开发设置

在 Gitlab 上fork YDBRust 仓库，克隆到您的机器上，然后用于开发。

git clone https://gitlab.com/YottaDB/Lang/YDBRust.git

cd YDBRust

source $(pkg-config --variable=prefix yottadb)/ydb_env_set

# install dependencies for bindgen and examples
# NOTE: this does not necessarily need apt, this is just an example
sudo apt update
sudo apt install clang libsdl2-dev libsdl2-ttf-dev libsdl2-gfx-dev

cargo test
cargo doc --open

您可能还想设置 pre-commit hooks

ln-s../../pre-commit.git/hooks/pre-commit

内部文档

YDBRust 具有与代码相同的内部文档，就像用户文档一样。尽可能的情况下，约定是在名为 INTERNAL_DOCS 的私有常量上放置内部文档，这允许通过 cargo doc --document-private-items 查看文档。

通常，关于 YDBRust 做什么和为什么的信息应该是面向用户的，关于如何的信息应该是内部的。

使用 Docker 进行开发

或者，您可以使用提供的 dockerfile

docker build --tag ydbrust .
docker run --volume "${PWD}":/opt/ydbrust -it ydbrust bash
source $(pkg-config --variable=prefix yottadb)/ydb_env_set
cargo test
cargo doc

文档将在本地可用，位于 file:///path/to/ydbrust/target/doc/yottadb/index.html。