该#[wasm_bindgen]macro支持大量配置,用于精确控制导入导入的方式以及它们在JS中映射的内容. 本节旨在有希望成为可能性的详尽参考!

• module和version- 我们见过module到目前为止表明我们可以从哪里导入物品version也允许:

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen(module = "moment", version = "^2.0.0")]
  extern {
      type Moment;
      fn moment() -> Moment;
      #[wasm_bindgen(method)]
      fn format(this: &Moment) -> String;
  }
  #}

  该modulekey用于配置从中导入每个项目的模块. 该versionkey不会影响生成的wasm本身,而是对像这样的工具的信息指令[WASM包-]. 像wasm-pack这样的工具会生成一个package.json为了你和version列在这里的时候module也是一个NPM包,将对应于写下来的内容package.json.

  换句话说就是用法module作为NPM包的名称和version因为版本要求允许您在Rust中内联,它依赖于NPM生态系统并从这些包中导入功能. 当捆绑一个像工具[WASM包-]一切都将自动与捆绑商联系,你应该好好去!

  请注意version是需要如果module不是从一开始./. 如果module以. . 开始./那么提供版本是错误的.

• catch- 此属性允许捕获JS异常. 这可以附加到任何导入的函数,函数必须返回一个Result哪里Err有效载荷是一个JsValue,像这样:

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      #[wasm_bindgen(catch)]
      fn foo() -> Result<(), JsValue>;
  }
  #}

  如果导入的函数抛出异常则Err将返回,但引发的异常,以及其他方式Ok与函数的结果一起返回.

  默认wasm-bindgen当wasm调用最终抛出异常的JS函数时,将不执行任何操作. 现在,wasm规范不支持堆栈展开,因此不支持Rust代码不会执行析构函数. 不幸的是,这可能导致Rust中的内存泄漏,但是只要wasm实现捕获异常,我们一定会添加支持!

• constructor- 这用于表示被绑定的函数应该实际转换为anewJS中的构造函数. 最后一个参数必须是从JS导入的类型,它将在JS中使用:

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(constructor)]
      fn new() -> Foo;
  }
  #}

  这将附上new功能Foo类型 (暗示constructor并且在JS中调用此函数时它将等效于new Foo().

• method- 这是通过方法等向导入的对象添加方法或以其他方式访问对象的属性的门户. 这应该是为了做相同的表达式foo.bar()在JS中.

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(method)]
      fn work(this: &Foo);
  }
  #}

  a的第一个参数method注释必须是附加方法所附类型的借用引用 (不可变,共享) . 在这种情况下,我们可以像这样调用这个方法foo.work()在JS (其中foo有类型Foo) .

  在JS中,这个调用将对应于访问Foo.prototype.work然后在调用import时调用它. 注意method默认情况下意味着经历prototype获取函数指针.

• js_namespace- 此属性指示通过特定名称空间访问JS类型. 比如说WebAssembly.ModuleAPI都是通过WebAssembly命名空间. 该js_namespace可以应用于任何导入,并且只要生成的JS尝试引用名称 (如类或函数名称) ,就可以通过此命名空间访问它.

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      #[wasm_bindgen(js_namespace = console)]
      fn log(s: &str);
  }
  #}

  这是如何绑定的示例console.log(x)在Rust. 该log函数将在Rust模块中可用,并将作为调用console.log在JS中.

• getter和setter- 这两个属性可以结合使用method表明这是一个getter或setter方法. 一个getter默认情况下,-tagged函数访问与getter函数同名的JS属性. 一个setter的功能名称目前需要以"set"开头_"它访问的属性是"set之后的后缀_".

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(method, getter)]
      fn property(this: &Foo) -> u32;
      #[wasm_bindgen(method, setter)]
      fn set_property(this: &Foo, val: u32);
  }
  #}

  我们在这里导入Foo键入并定义访问每个对象的能力property属性. 这里的第一个函数是一个getter,将在Rust中可用foo.property(),后者是可以访问的setterfoo.set_property(2). 请注意,这两个函数都有this他们被标记的论点method.

  最后,您还可以将参数传递给getter和setter用于配置访问哪个属性的属性. 显式指定属性时,方法名称没有限制. 例如,以下内容相当于上述内容:

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(method, getter = property)]
      fn assorted_method_name(this: &Foo) -> u32;
      #[wasm_bindgen(method, setter = "property")]
      fn some_other_method_name(this: &Foo, val: u32);
  }
  #}

  JS中的属性可以通过访问Object.getOwnPropertyDescriptor. 请注意,这通常仅适用于类类定义的属性,这些属性不仅仅是任何旧对象的附加属性. 要访问对象上的任何旧属性,我们可以使用...

• structural- 这是一面旗帜method注释表明应该以结构方式访问被访问的方法 (或具有getter / setter的属性) . 例如,方法是不通过访问prototype和属性直接在对象上访问而不是通过Object.getOwnPropertyDescriptor.

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(method, structural)]
      fn bar(this: &Foo);
      #[wasm_bindgen(method, getter, structural)]
      fn baz(this: &Foo) -> u32;
  }
  #}

  这里的类型,Foo,不需要存在于JS中 (它没有被引用) . 相反,wasm-bindgen将生成将访问传入的JS值的填充程序bar财产到或baz财产 (取决于职能) .

• js_name = foo- 这可以用于绑定JS中的不同函数,而不是Rust中定义的标识符. 例如,您还可以在JS中为多态函数定义多个签名:

  
  # #![allow(unused_variables)]
  #fn main() {
  #[wasm_bindgen]
  extern {
      type Foo;
      #[wasm_bindgen(js_namespace = console, js_name = log)]
      fn log_string(s: &str);
      #[wasm_bindgen(js_namespace = console, js_name = log)]
      fn log_u32(n: u32);
      #[wasm_bindgen(js_namespace = console, js_name = log)]
      fn log_many(a: u32, b: JsValue);
  }
  #}

  所有这些功能都会调用console.log在Rust中,但每个标识符在Rust中只有一个签名.