diff --git a/guide/src/SUMMARY.md b/guide/src/SUMMARY.md index 26f8ce3a..524d1e40 100644 --- a/guide/src/SUMMARY.md +++ b/guide/src/SUMMARY.md @@ -10,6 +10,7 @@ - [Closures](./closures.md) - [Feature Reference](./feature-reference.md) - [CLI Reference](./cli-reference.md) +- [Type Reference](./reference.md) -------------------------------------------------------------------------------- diff --git a/guide/src/reference.md b/guide/src/reference.md new file mode 100644 index 00000000..56022337 --- /dev/null +++ b/guide/src/reference.md @@ -0,0 +1,21 @@ +# Reference + +The table below provides an overview of all the types that wasm-bindgen can send/receive across the wasm ABI boundary. + +| Type | `T` parameter | `&T` parameter | `&mut T` parameter | `T` return value | +|:---:|:---:|:---:|:---:|:---:| +| `str` | No | Yes | No | Yes | +| `char` | Yes | No | No | Yes | +| `bool` | Yes | No | No | Yes | +| `JsValue` | Yes | Yes | Yes | Yes | +| `Box<[JsValue]>` | Yes | No | No | Yes | +| `*const T` | Yes | No | No | Yes | +| `*mut T` | Yes | No | No | Yes | +| `u8` `i8` `u16` `i16` `u64` `i64` `isize` `size` | Yes | No | No | Yes | +| `u32` `i32` `f32` `f64` | Yes | Yes | Yes | Yes | +| `Box<[u8]>` `Box<[i8]>` `Box<[u16]>` `Box<[i16]>` `Box<[u32]>` `Box<[i32]>` `Box<[u64]>` `Box<[i64]>` | Yes | No | No | Yes | +| `Box<[f32]>` `Box<[f64]>` | Yes | No | No | Yes | +| `[u8]` `[i8]` `[u16]` `[i16]` `[u32]` `[i32]` `[u64]` `[i64]` | No | Yes | Yes | No | +| `&[u8]` `&mut[u8]` `&[i8]` `&mut[i8]` `&[u16]` `&mut[u16]` `&[i16]` `&mut[i16]` `&[u32]` `&mut[u32]` `&[i32]` `&mut[i32]` `&[u64]` `&mut[u64]` `&[i64]` `&mut[i64]` | No | No | No | Yes | +| `[f32]` `[f64]` | No | Yes | Yes | No | +| `&[f32]` `&mut[f32]` `&[f64]` `&mut[f64]` | No | No | No | Yes | \ No newline at end of file