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] 过程宏可以应用于
  • 函数 使其可以从模块导出
  • 外部块 使其以 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 类型的结构体
• 所有字段都是上述类型或其他以这种方式构建的结构体的结构体