首页 > 解决方案 > 如何通过 WebAssembly 将 Rust 闭包返回给 JavaScript?

问题描述

关于closure.rs的评论非常棒,但是我不能让它从WebAssembly 库返回一个闭包。

我有这样的功能:

#[wasm_bindgen]
pub fn start_game(
    start_time: f64,
    screen_width: f32,
    screen_height: f32,
    on_render: &js_sys::Function,
    on_collision: &js_sys::Function,
) -> ClosureTypeHere {
    // ...
}

在那个函数里面我做了一个闭包,假设Closure::wrap是拼图的一部分,并从closure.rs复制):

let cb = Closure::wrap(Box::new(move |time| time * 4.2) as Box<FnMut(f64) -> f64>);

我如何返回这个回调,start_game应该ClosureTypeHere是什么?

这个想法是start_game创建本地可变对象——比如相机,JavaScript 端应该能够调用 Rust 返回的函数以更新该相机。

标签: rustwebassemblywasm-bindgen

解决方案


这是一个很好的问题,也有一些细微差别!值得一提的是指南中的闭包示例(以及关于将闭包传递给 JavaScript 的部分),如果有必要,最好也贡献一下!wasm-bindgen

但是,为了让您开始,您可以执行以下操作:

use wasm_bindgen::{Closure, JsValue};

#[wasm_bindgen]
pub fn start_game(
    start_time: f64,
    screen_width: f32,
    screen_height: f32,
    on_render: &js_sys::Function,
    on_collision: &js_sys::Function,
) -> JsValue {
    let cb = Closure::wrap(Box::new(move |time| {
        time * 4.2
    }) as Box<FnMut(f64) -> f64>);

    // Extract the `JsValue` from this `Closure`, the handle
    // on a JS function representing the closure
    let ret = cb.as_ref().clone();

    // Once `cb` is dropped it'll "neuter" the closure and
    // cause invocations to throw a JS exception. Memory
    // management here will come later, so just leak it
    // for now.
    cb.forget();

    return ret;
}

返回值上方只是一个普通的 JS 对象(这里是 a JsValue),我们使用Closure您已经看到的类型创建它。这将允许您快速将闭包返回给 JS,并且您也可以从 JS 调用它。

您还询问过存储可变对象等问题,这都可以通过普通的 Rust 闭包、捕获等来完成。例如,FnMut(f64) -> f64上面的声明是 JS 函数的签名,可以是任何类型的集合,例如好像FnMut(String, MyCustomWasmBindgenType, f64) -> Vec<u8>你真的想要一样。要捕获本地对象,您可以执行以下操作:

let mut camera = Camera::new();
let mut state = State::new();
let cb = Closure::wrap(Box::new(move |arg1, arg2| { // note the `move`
    if arg1 {
        camera.update(&arg2);
    } else {
        state.update(&arg2);
    }
}) as Box<_>);

(或类似的东西)

这里cameraandstate变量将由闭包拥有并同时被删除。更多关于闭包的信息可以在 Rust book 中找到

在这里简要介绍一下内存管理方面也是值得的。在上面的示例中,我们调用forget()which 泄漏内存,如果多次调用 Rust 函数(因为它会泄漏大量内存),可能会出现问题。这里的根本问题是在创建的 JS 函数对象引用的 WASM 堆上分配了内存。理论上,只要 JS 函数对象被 GC 处理,就需要释放分配的内存,但我们无法知道何时发生(直到WeakRef存在!)。

与此同时,我们选择了另一种策略。Closure每当删除类型本身时,关联的内存就会被释放,从而提供确定性销毁。然而,这使得使用起来很困难,因为我们需要手动确定何时删除Closure. 如果forget不适用于您的用例,则删除的一些想法Closure是:

  • 首先,如果它是一个只调用一次的 JS 闭包,那么您可以使用Rc/RefCellClosure闭包本身放在内部(使用一些内部可变性恶作剧)。我们最终FnOnce也应该为in提供原生支持wasm-bindgen

  • 接下来,您可以将辅助 JS 对象返回给具有手动free 方法的 Rust。例如一个带#[wasm_bindgen]注释的包装器。然后需要在适当的时候在 JS 中手动释放这个包装器。

如果你能过得去,forget是目前为止最容易做的事情,但这绝对是一个痛点!我们迫不及待WeakRef地想要存在:)


推荐阅读