65 lines
1.5 KiB
Markdown
Raw Normal View History

2019-04-30 10:26:03 -03:00
# `getter` and `setter`
2019-04-30 10:06:38 -07:00
The `getter` and `setter` attributes can be used in Rust `impl` blocks to define
properties in JS that act like getters and setters of a field. For example:
2019-04-30 10:26:03 -03:00
```rust
#[wasm_bindgen]
pub struct Baz {
field: i32,
}
#[wasm_bindgen]
impl Baz {
2019-04-30 10:06:38 -07:00
#[wasm_bindgen(constructor)]
pub fn new(field: i32) -> Baz {
Baz { field }
}
2019-04-30 10:26:03 -03:00
#[wasm_bindgen(getter)]
pub fn field(&self) -> i32 {
self.field
}
2019-04-30 10:06:38 -07:00
#[wasm_bindgen(setter)]
2019-04-30 10:26:03 -03:00
pub fn set_field(&mut self, field: i32) {
self.field = field;
}
}
```
Can be combined in `JavaScript` like in this snippet:
```js
2019-04-30 10:06:38 -07:00
const obj = new Baz(3);
assert.equal(obj.field, 3);
obj.field = 4;
assert.equal(obj.field, 4);
```
You can also configure the name of the property that is exported in JS like so:
```rust
#[wasm_bindgen]
impl Baz {
#[wasm_bindgen(getter = anotherName)]
pub fn field(&self) -> i32 {
self.field
}
#[wasm_bindgen(setter = anotherName)]
pub fn set_field(&mut self, field: i32) {
self.field = field;
}
}
```
Getters are expected to take no arguments other than `&self` and return the
field's type. Setters are expected to take one argument other than `&mut self`
(or `&self`) and return no values.
The name for a `getter` is by default inferred from the function name it's
attached to. The default name for a `setter` is the function's name minus the
`set_` prefix, and if `set_` isn't a prefix of the function it's an error to not
provide the name explicitly.