#plugin #plugy #wasi #inventory

plugy-runtime

plugy使您能够使用Rust和WASM构建通用的动态插件系统

6个版本

0.3.1 2023年12月14日
0.3.0 2023年12月3日
0.2.1 2023年8月31日
0.1.1 2023年8月9日

#751 in WebAssembly

每月48次下载
用于 plugy

MIT/Apache

38KB
305

GitHub Actions GitHub Releases

plugy

plugy是一个插件系统,旨在使Rust插件能够无缝集成到您的应用程序中。它为加载和执行用WebAssembly(Wasm)编写的插件提供了一个运行时环境,使您的Rust项目具有动态可扩展性和模块化。

特性

  • 加载和执行编译为WASM的插件。
  • 灵活的插件运行时管理。
  • 对插件函数的调用是异步的。
  • 用于生成插件接口的简单宏。

入门

要在您的Rust项目中使用plugy,请按照以下步骤操作

  1. 编写您的插件trait
#[plugy::plugin]
trait Greeter {
    fn greet(&self) -> String;
}
  1. 编写您的第一个插件实现
#[derive(Debug, Deserialize)]
struct FooPlugin;

#[plugin_impl]
impl Greeter for FooPlugin {
    fn greet(&self) -> String {
        "Hello From Foo Plugin".to_owned()
    }
}

编译它!

cargo build --target wasm32-unknown-unknown
  1. 导入并运行
#[plugin_import(file = "target/wasm32-unknown-unknown/debug/foo_plugin.wasm")]
struct FooPlugin;

#[tokio::main]
async fn main() {
    let runtime = Runtime::<Box<dyn Greeter>>::new().unwrap();
    let handle = runtime.load(FooPlugin).await.unwrap();
    let res = handle.greet().await;
    assert_eq!(res, "Hello From Foo Plugin")
}

然后您就设置好了!

示例

请参阅示例目录以了解plugy的示例用法。

里程碑

状态 目标 标签
接受插件函数中的多个参数 完成
在主机和客人之间传递上下文 完成

功能

Plugy由三个基本crate组成,每个crate在用Rust和WebAssembly构建动态插件系统时都发挥着独特的作用

  • core: 此crate包含位操作工具和客人模块等基本组件,构成了Plugy功能的基础。

  • runtime: 运行时crate协调您的插件系统的执行,使插件能够无缝集成到您的应用程序中。

  • macros: macros crate提供了一系列宏,简化了绑定和接口的生成,简化了与动态插件一起工作的过程。

贡献

欢迎为plugy做出贡献!如果您发现了一个错误或想要提议一个新功能,请随时创建一个问题或提交一个pull请求。

感谢

许可证

本项目采用MIT或Apache-2.0许可证。

依赖项

~16–26MB
~404K SLoC