6个版本

新版本 0.1.5 2024年8月16日
0.1.4 2024年8月10日
0.1.2 2024年5月11日

1045WebAssembly 中排名

Download history 165/week @ 2024-05-03 189/week @ 2024-05-10 2/week @ 2024-05-17 115/week @ 2024-08-02 121/week @ 2024-08-09

每月 236 下载
egui_wings_host 中使用

MIT/ApacheGPL-3.0-or-later

87KB
1.5K SLoC

Wings

Crates.io Docs.rs

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

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

// 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}'");
    }
}

通常,使用原始Geese可以做到的任何事情也可以使用Wings做到。请参阅示例以演示更多功能。

依赖关系

~2.2–4.5MB
~92K SLoC