7个版本

0.1.5 2024年8月16日
0.1.4 2024年8月10日
0.1.2 2024年5月11日
0.0.0 2024年5月1日

#1103 in 过程宏

Download history 206/week @ 2024-05-03 202/week @ 2024-05-10 17/week @ 2024-05-17 3/week @ 2024-05-24 119/week @ 2024-08-02 137/week @ 2024-08-09 139/week @ 2024-08-16

每月下载量:395
3 个Crates中使用 (通过 wings)

MIT/Apache

27KB
490

Wings

Crates.io Docs.rs

Wings是Rust的WASM插件系统。它直接与Geese事件库集成,允许插件通过事件和系统无缝地相互通信以及与宿主通信。支持以下功能

  • 向宿主发送事件:访客可以向宿主发送和接收强类型事件,这些事件将被注入到宿主的Geese上下文中。
  • 向其他访客系统发送事件:事件将在访客系统之间传播,并从宿主的Geese上下文中传播到WASM模块。
  • 访问宿主的系统:宿主可以将Geese系统作为特质对象公开,这些对象可以直接从访客中调用。函数参数和返回类型在WASM边界处进行序列化。
  • 访问其他插件的系统:插件可以将它们的系统作为特质对象公开,其他插件可以调用这些系统。就像常规的Geese一样,Wings保证每个系统都是单例 - 如果加载了共享依赖项的单独插件,则两个插件都将访问相同的依赖项实例。
  • 自动解析插件依赖项/版本:插件作为包含所有传递依赖项的Rust Crates构建,因此无需担心创建依赖项解析器。每次Wings加载系统时,它都会从加载的插件集中选择最新兼容Semver的版本。

示例

以下是如何使用Wings的简略示例。完整的代码可以在wings_example文件夹中找到。

Wings允许定义如下特质,这些特质可以在宿主代码和插件代码之间共享

// Define a system that the host will expose.
// This can also be used to expose guest systems to other guest systems.
#[system_trait(host)]
pub trait ExampleSystem: 'static {
    // Prints a value to the console.
    fn print(&self, value: &str);
}

然后,可以从WASM中作为特质对象引用系统

// Define a Wings system that will run within WASM
#[export_system]
pub struct PluginSystem;

impl WingsSystem for PluginSystem {
    // Declare a dependency on the exported host system
    const DEPENDENCIES: Dependencies = dependencies()
        .with::<dyn ExampleSystem>();

    // Invoked when the plugin is created
    fn new(mut ctx: WingsContextHandle<Self>) -> Self {
        // Get the system from WASM and invoke its function
        ctx.get::<dyn ExampleSystem>().print(&format!("Hello from WASM!"));
        Self
    }
}

最后,系统可以在宿主上实现并暴露给插件

// Define a host type
pub struct TestHost;

impl Host for TestHost {
    // Declare the systems that should be exported to WASM,
    // and the traits under which they should be exported
    const SYSTEMS: Systems<Self> = systems()
        .with::<ExampleSystemImpl>(traits()
            .with::<dyn example_host_system::ExampleSystem>());

    ...
}

// Declare an implementation for the WASM-exported system
pub struct ExampleSystemImpl;

impl ExampleSystem for ExampleSystemImpl {
    fn print(&self, value: &str) {
        println!("Plugin says '{value}'");
    }
}

通常情况下,Wings 可以实现任何使用普通鹅(vanilla Geese)能实现的功能。请参阅示例以了解更多功能。

依赖项

约 250-700KB
约 17K SLoC