Eclipse uProtocol Rust库

这是针对Rust编程语言的uProtocol v1.6.0-alpha.3 语言库。

该crate可用于

• 实现使用支持的传输协议之一通过uProtocol 通信层API相互通信的uEntities。
• 通过实现传输层API来支持额外的传输协议。

使用Crate

需要将crate添加到[dependencies]部分的Cargo.toml文件中

[dependencies]
up-rust = { version = "0.1" }

大多数开发者将想要使用通信层API及其默认实现，这些由communication模块提供。

从源代码构建

首先，需要使用以下命令克隆仓库

git clone --recurse-submodules [email protected]:eclipse-uprotocol/up-rust

带有--recurse-submodules参数非常重要，以确保在工作区中初始化指向uProtocol类型定义的git子模块。该子模块包含的proto3文件定义了uProtocol的基本类型，并在构建过程中编译成Rust代码。如果已使用参数克隆了仓库，则可以使用以下命令手动初始化子模块：git submodule update --init --recursive。

然后可以从根目录使用Cargo包管理器构建crate

cargo build

该包包含一些（可选的）功能，具体请参考 lib.rs 文档。

可以通过将以下内容放入 ./vscode/settings.json 来指示 VSCode 自动构建所有功能：

{
  "rust-analyzer.cargo.features": "all"
}

生成 API 文档

可以使用以下方式生成 API 文档：

cargo doc --no-deps --all-features --open

许可证

该包在 Apache License 2.0 许可证下发布，具体请参考 LICENSE 文件。

贡献

我们非常欢迎贡献。请参阅 贡献指南。