46个版本 (5 个破坏性版本)
0.6.9 | 2021年5月19日 |
---|---|
0.6.1 | 2021年4月27日 |
0.5.0 | 2021年3月12日 |
0.2.14 | 2020年12月31日 |
0.1.4 | 2019年3月27日 |
#2872 in 神奇豆
在 14 个crate中(4个直接)使用
26KB
409 行
Marine Rust SDK
此SDK使开发者能够创建通用Wasm模块,并在interface-types和无共享链接方案的帮助下,将它们组合成多模块设置。SDK提供所有必要的宏和其他功能,使Wasm开发过程尽可能接近“vanilla”Rust。编译的模块旨在与Marine运行时一起运行。
用法
SDK的核心组件是用于导出函数、外部块和结构的#[marine]
宏。让我们考虑一个具有一个导出函数的简单场景
use marine_rs_sdk::marine;
#[marine]
pub fn greeting(name: String) -> String {
format!("Hi, {}", name)
}
此代码导入Marine SDK,并使用#[marine]
宏包装问候函数。所有以这种方式包装的函数都将从编译的Wasm模块中导出。
要编译此代码到Wasm,您需要Marine CLI工具。如果您尚未安装cli,请使用cargo install marine
marine build --release
最后,您将获得一个嵌入到Wasm二进制文件中的构建清单,并可以与Marine REPL(mrepl)中的模块进行交互。如果您还没有,请使用cargo install mrepl
进行安装
> marine info ./target/wasm32-wasi/release/greeting.wasm
it version: 0.23.1
sdk version: 0.7.0
authors: <user-name>
version: 0.1.0
description:
repository:
build time: 2023-02-15 18:52:37.865550 +00:00 UTC
> mrepl --quiet
1> load greeting ./target/wasm32-wasi/release/greeting.wasm
module successfully loaded into App service
elapsed time: 52.153308ms
2> interface
Application service interface:
greeting:
fn greeting(name: String) -> String
3> call greeting greeting "user"
result: String("Hi, user")
elapsed time: 132.021µs
开发此简单模块的完整指南可以在这里找到。
SDK组件
SDK导出以下主要组件
#[marine]
过程宏可以应用于- 调用参数接口,旨在提供一组模块启动参数
- 挂载的二进制接口,可以用来调用CLI工具
- module_manifest宏,旨在将一些信息嵌入编译后的Wasm
- 日志功能,允许调整Marine日志机制
支持的Rust类型
目前,#[marine]
宏允许以下Rust类型作为导出和导入函数的参数或结构体字段的类型
- 以下Rust基本类型之一:
bool
、u8
、u16
、u32
、u64
、i8
、i16
、i32
、i64
、f32
、f64
- 字符串
String
、&str
- 以上类型的元素组成的向量
- 由以上类型组成的向量,其中可以接受递归,例如,类型
Vec<Vec<Vec<u8>>>
是可接受的 - 所有以上类型的引用
- 所有字段都是Rust基本类型的结构体
- 所有字段都是以上类型或其他以这种方式构建的结构体的结构体
文档
还可以查看我们的YouTube频道。
仓库结构
- crates
- macro-testing-utils包含内部测试工具
- main包含export_allocator、logger和results模块
- marine-macro是
#[marine]
宏的proc-macro crate - marine-macro-impl 是宏
#[marine]
的实际实现 - timestamp-macro 是一个宏,用于将时间戳嵌入编译后的 Wasm 二进制文件
- src 包含 call_parameters 和 mounted_binary 模块,并重新导出所有用户所需的内容
支持
如果您发现错误,请提交问题。您也可以通过 Discord 或 Telegram 与我们联系。我们将尽力尽快解决该问题。
贡献
任何感兴趣的人都可以为项目做出贡献。请确保您阅读并遵循一些基本的 规则。
许可
所有软件代码均为 Fluence Labs, Inc. 版权所有,并根据 Apache-2.0 许可证授权。
依赖项
~3MB
~67K SLoC