fluencelabs/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasm-bindgen synced 2025-06-02 15:41:24 +00:00
Code Issues Projects Releases Wiki Activity
wasm-bindgen/guide/src/SUMMARY.md

117 lines
6.7 KiB
Markdown
Raw Normal View History

guide: Add the `wasm-bindgen` guide Essentially split up the monolithic README.md into an `mdbook`.
2018-06-19 11:08:54 -07:00
# Summary
[Introduction](./introduction.md)
--------------------------------------------------------------------------------
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
- [Examples](./examples/index.md)
- [Hello, World!](./examples/hello-world.md)
- [Using `console.log`](./examples/console-log.md)
- [Small wasm files](./examples/add.md)
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
- [Without a Bundler](./examples/without-a-bundler.md)
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
- [Converting WebAssembly to JS](./examples/wasm2js.md)
- [Importing functions from JS](./examples/import-js.md)
- [Working with `char`](./examples/char.md)
- [js-sys: WebAssembly in WebAssembly](./examples/wasm-in-wasm.md)
- [web-sys: DOM hello world](./examples/dom.md)
- [web-sys: Closures](./examples/closures.md)
- [web-sys: `performance.now`](./examples/performance.md)
- [web-sys: using `fetch`](./examples/fetch.md)
- [web-sys: `canvas` hello world](./examples/2d-canvas.md)
- [web-sys: `canvas` Julia set](./examples/julia.md)
- [web-sys: WebAudio](./examples/web-audio.md)
- [web-sys: WebGL](./examples/webgl.md)
added websockets example to the guide
2019-06-01 16:17:50 +03:00
- [web-sys: WebSockets](./examples/websockets.md)
examples: Add a requestAnimationFrame loop example
2018-12-10 12:50:19 -08:00
- [web-sys: `requestAnimationFrame`](./examples/request-animation-frame.md)
Reorganize and rewrite examples This commit is a large-ish scale reorganization of our examples. The main goal here is to have a dedicated section of the guide for example, and all examples will be listed there. Each example's `README` is now just boilerplate pointing at the guide along with a blurb about how to run it. Some examples like `math` and `smorgasboard` have been deleted as they didn't really serve much purpose, and others like `closures` have been rewritten with `web-sys` instead of hand-bound bindings. Overall it's hoped that this puts us in a good and consistent state for our examples, with all of them being described in the guide, excerpts are in the guide, and they're all relatively idiomatically using `web-sys`.
2018-09-20 16:20:42 -07:00
- [web-sys: A Simple Paint Program](./examples/paint.md)
Implement support for WebAssembly threads ... and add a parallel raytracing demo! This commit adds enough support to `wasm-bindgen` to produce a workable wasm binary *today* with the experimental WebAssembly threads support implemented in Firefox Nightly. I've tried to comment what's going on in the commits and such, but at a high level the changes made here are: * A new transformation, living in a new `wasm-bindgen-threads-xform` crate, prepares a wasm module for parallel execution. This performs a number of mundane tasks which I hope to detail in a blog post later on. * The `--no-modules` output is enhanced with more support for when shared memory is enabled, allowing passing in the module/memory to initialize the wasm instance on multiple threads (sharing both module and memory). * The `wasm-bindgen` crate now offers the ability, in `--no-modules` mode, to get a handle on the `WebAssembly.Module` instance. * The example itself requires Xargo to recompile the standard library with atomics and an experimental feature enabled. Afterwards it experimentally also enables threading support in wasm-bindgen. I've also added hopefully enough CI support to compile this example in a builder so we can upload it and poke around live online. I hope to detail more about the technical details here in a blog post soon as well!
2018-10-04 20:00:23 -07:00
- [Parallel Raytracing](./examples/raytrace.md)
Adding in TODO MVC example using web-sys
2018-10-13 01:21:14 +01:00
- [web-sys: A TODO MVC App](./examples/todomvc.md)
guide: Organize docs into "Whirlwind Tour" and "Reference" sections First part of #616
2018-08-03 15:14:06 -07:00
- [Reference](./reference/index.md)
Tweak introductory and deployment documentation. This commit rejiggers some documentation of `wasm-bindgen` in a few significant ways: * The main landing page now has text and links to the Game of Life tutorial and `wasm-pack`. * The "whirlwind tour" was deleted as it wasn't really serving any purpose that the Game of Life plus the later references weren't already serving. * The "no modules" example was renamed to "without a bundler" * A dedicated section on "Deployment" was added which replaces the previous "No ES Modules" page. This is hopefully more descriptive and also prominently mentions the various options for deployment.
2019-02-21 11:49:08 -08:00
- [Deployment](./reference/deployment.md)
Implement the local JS snippets RFC This commit is an implementation of [RFC 6] which enables crates to inline local JS snippets into the final output artifact of `wasm-bindgen`. This is accompanied with a few minor breaking changes which are intended to be relatively minor in practice: * The `module` attribute disallows paths starting with `./` and `../`. It requires paths starting with `/` to actually exist on the filesystem. * The `--browser` flag no longer emits bundler-compatible code, but rather emits an ES module that can be natively loaded into a browser. Otherwise be sure to check out [the RFC][RFC 6] for more details, and otherwise this should implement at least the MVP version of the RFC! Notably at this time JS snippets with `--nodejs` or `--no-modules` are not supported and will unconditionally generate an error. [RFC 6]: https://github.com/rustwasm/rfcs/pull/6 Closes #1311
2019-02-25 11:11:30 -08:00
- [JS snippets](./reference/js-snippets.md)
guide: Clean up passing rust closures to JS section; add passing JS closures to rust section
2018-08-06 17:43:36 -07:00
- [Passing Rust Closures to JS](./reference/passing-rust-closures-to-js.md)
- [Receiving JS Closures in Rust](./reference/receiving-js-closures-in-rust.md)
guide: Add a reference section for Promises and Futures
2018-08-13 15:44:28 -07:00
- [`Promise`s and `Future`s](./reference/js-promises-and-rust-futures.md)
guide: Add section about iterating over JS values
2018-09-25 13:31:54 -07:00
- [Iterating over JS Values](./reference/iterating-over-js-values.md)
guide: Polish Serializing + Deserializing into/from JsValue with Serde section
2018-08-07 14:24:26 -07:00
- [Arbitrary Data with Serde](./reference/arbitrary-data-with-serde.md)
guide: Add section on accessing properties of untyped values Part of #616
2018-09-11 15:26:51 -07:00
- [Accessing Properties of Untyped JS Values](./reference/accessing-properties-of-untyped-js-values.md)
guide: Add section on working with duck-typed interfaces
2018-09-11 16:29:44 -07:00
- [Working with Duck-Typed Interfaces](./reference/working-with-duck-typed-interfaces.md)
guide: Clean up title and URL of CLI reference section
2018-08-03 15:34:35 -07:00
- [Command Line Interface](./reference/cli.md)
Add some blurbs about optimizing for size The main thing we mention is to explicitly not measure the output of the compiler, but only the ouput of `wasm-bindgen` itself. Closes #826
2018-09-24 11:28:02 -07:00
- [Optimizing for Size](./reference/optimize-size.md)
Add documentation about supported targets * Main target is wasm32-unknown-unknown * All other targets work ok, but imports panic * Emscripten explicitly not supported at this time Closes #892
2018-09-27 12:29:56 -07:00
- [Supported Rust Targets](./reference/rust-targets.md)
Fix polyfill of `TextEncoder` and `TextDecoder` This commit does a few things, including: * Fixing the generated JS of `wasm-bindgen` to allow polyfills to work. (a minor tweak of the generated JS) * All examples are updated to include a Webpack-specific polyfill for these two types to get examples working in Edge. * A new page has been added to the guide about supported browsers. This mentions known caveats like IE 11 requiring `wasm2js` as well as documenting some `TextEncoder` and `TextDecoder` workarounds for Edge. Closes #895
2018-09-28 20:01:46 -07:00
- [Supported Browsers](./reference/browser-support.md)
guide: Rename "Type Reference" section to "Supported Types"
2018-08-03 16:11:34 -07:00
- [Supported Types](./reference/types.md)
guide: Split supported types section up into many sub sections
2018-08-14 18:01:17 -07:00
- [Imported JavaScript Types](./reference/types/imported-js-types.md)
- [Exported Rust Types](./reference/types/exported-rust-types.md)
- [`JsValue`](./reference/types/jsvalue.md)
- [`Box<[JsValue]>`](./reference/types/boxed-jsvalue-slice.md)
- [`*const T` and `*mut T`](./reference/types/pointers.md)
- [Numbers](./reference/types/numbers.md)
- [`bool`](./reference/types/bool.md)
- [`char`](./reference/types/char.md)
- [`str`](./reference/types/str.md)
- [`String`](./reference/types/string.md)
- [Number Slices](./reference/types/number-slices.md)
- [Boxed Number Slices](./reference/types/boxed-number-slices.md)
Allow returning `Result` from functions This commit adds support for exporting a function defined in Rust that returns a `Result`, translating the `Ok` variant to the actual return value and the `Err` variant to an exception that's thrown in JS. The support for return types and descriptors was rejiggered a bit to be a bit more abstract and more well suited for this purpose. We no longer distinguish between functions with a return value and those without a return value. Additionally a new trait, `ReturnWasmAbi`, is used for converting return values. This trait is an internal implementation detail, however, and shouldn't surface itself to users much (if at all). Closes #841
2018-09-17 18:26:45 -07:00
- [`Result<T, JsValue>`](./reference/types/result.md)
guide: add exhuastive reference docs for #[wasm_bindgen] attributes
2018-08-06 16:35:28 -07:00
- [`#[wasm_bindgen]` Attributes](./reference/attributes/index.md)
- [On JavaScript Imports](./reference/attributes/on-js-imports/index.md)
- [`catch`](./reference/attributes/on-js-imports/catch.md)
- [`constructor`](./reference/attributes/on-js-imports/constructor.md)
Implement `#[wasm_bindgen(extends = ...)]` This commit implements the `extends` attribute for `#[wasm_bindgen]` to statically draw the inheritance hierarchy in the generated bindings, generating appropriate `AsRef`, `AsMut`, and `From` implementations.
2018-08-04 10:00:30 -07:00
- [`extends`](./reference/attributes/on-js-imports/extends.md)
guide: add exhuastive reference docs for #[wasm_bindgen] attributes
2018-08-06 16:35:28 -07:00
- [`getter` and `setter`](./reference/attributes/on-js-imports/getter-and-setter.md)
Rename `host_binding` to `final`
2018-11-09 07:59:48 -08:00
- [`final`](./reference/attributes/on-js-imports/final.md)
guide: add `indexing_{getter,setter,deleter}` attribute page
2018-08-07 11:50:40 -07:00
- [`indexing_getter`, `indexing_setter`, and `indexing_deleter`](./reference/attributes/on-js-imports/indexing-getter-setter-deleter.md)
guide: add exhuastive reference docs for #[wasm_bindgen] attributes
2018-08-06 16:35:28 -07:00
- [`js_class = "Blah"`](./reference/attributes/on-js-imports/js_class.md)
- [`js_name`](./reference/attributes/on-js-imports/js_name.md)
- [`js_namespace`](./reference/attributes/on-js-imports/js_namespace.md)
- [`method`](./reference/attributes/on-js-imports/method.md)
- [`module = "blah"`](./reference/attributes/on-js-imports/module.md)
Add a `raw_module` attribute to `#[wasm_bindgen]` This allows subverting the checks and resolution performed by the `module` attribute added as part of [RFC 6] and has been discussed in #1343. Closes #1343 [RFC 6]: https://github.com/rustwasm/rfcs/pull/6
2019-03-15 08:04:25 -07:00
- [`raw_module = "blah"`](./reference/attributes/on-js-imports/raw_module.md)
guide: add exhuastive reference docs for #[wasm_bindgen] attributes
2018-08-06 16:35:28 -07:00
- [`static_method_of = Blah`](./reference/attributes/on-js-imports/static_method_of.md)
guide: Fix alphabetizing of attributes
2018-08-07 11:14:00 -07:00
- [`structural`](./reference/attributes/on-js-imports/structural.md)
Implement a `polyfill` attribute for imports Allow using imported APIs under alternative names, such as prefixed names, for web APIs when the exact API differs across browsers.
2018-09-28 13:17:37 -07:00
- [`variadic`](./reference/attributes/on-js-imports/variadic.md)
Rename `polyfill` to `vendor_prefix` cc #906
2018-10-01 12:33:33 -07:00
- [`vendor_prefix`](./reference/attributes/on-js-imports/vendor_prefix.md)
guide: add exhuastive reference docs for #[wasm_bindgen] attributes
2018-08-06 16:35:28 -07:00
- [On Rust Exports](./reference/attributes/on-rust-exports/index.md)
- [`constructor`](./reference/attributes/on-rust-exports/constructor.md)
- [`js_name = Blah`](./reference/attributes/on-rust-exports/js_name.md)
- [`readonly`](./reference/attributes/on-rust-exports/readonly.md)
add wasm_bindgen(skip) to reference
2019-04-14 23:49:24 +03:00
- [`skip`](./reference/attributes/on-rust-exports/skip.md)
Add a `#[wasm_bindgen(start)]` attribute This commit adds a new attribute to `#[wasm_bindgen]`: `start`. The `start` attribute can be used to indicate that a function should be executed when the module is loaded, configuring the `start` function of the wasm executable. While this doesn't necessarily literally configure the `start` section, it does its best! Only one crate in a crate graph may indicate `#[wasm_bindgen(start)]`, so it's not recommended to be used in libraries but only end-user applications. Currently this still must be used with the `crate-type = ["cdylib"]` annotation in `Cargo.toml`. The implementation here is somewhat tricky because of the circular dependency between our generated JS and the wasm file that we emit. This circular dependency makes running initialization routines (like the `start` shim) particularly fraught with complications because one may need to run before the other but bundlers may not necessarily respect it. Workarounds have been implemented for various emission strategies, for example calling the start function directly after exports are wired up with `--no-modules` and otherwise working around what appears to be a Webpack bug with initializers running in a different order than we'd like. In any case, this in theory doesn't show up to the end user! Closes #74
2018-11-28 09:25:51 -08:00
- [`start`](./reference/attributes/on-rust-exports/start.md)
Adds support for #[wasm_bindgen(typescript_custom_section)].
2018-11-17 23:04:19 -05:00
- [`typescript_custom_section`](./reference/attributes/on-rust-exports/typescript_custom_section.md)
Getters/Setters for fields
2019-04-30 10:26:03 -03:00
- [`getter` and `setter`](./reference/attributes/on-rust-exports/getter-and-setter.md)
guide: Add a contributing section and move DESIGN.md under it Also adds a team section where we enumerate the folks on the `wasm-bindgen` team and who can review pull requests
2018-06-19 11:39:38 -07:00
guide: Add a user-facing `web-sys` section
2018-09-10 17:51:44 -07:00
- [`web-sys`](./web-sys/index.md)
- [Using `web-sys`](./web-sys/using-web-sys.md)
- [Cargo Features](./web-sys/cargo-features.md)
- [Function Overloads](./web-sys/function-overloads.md)
- [Type Translations](./web-sys/type-translations.md)
Implement `Deref` for all imported JS types This commit implements the first half of [RFC #5] where the `Deref` trait is implemented for all imported types. The target of `Deref` is either the first entry of the list of `extends` attribute or `JsValue`. All examples using `.as_ref()` with various `web-sys` types have been updated to the more ergonomic deref casts now. Additionally the `web-sys` generation of the `extends` array has been fixed slightly to explicitly list implementatoins in the hierarchy order to ensure the correct target for `Deref` is chosen. [RFC #5]: https://github.com/rustwasm/rfcs/blob/master/text/005-structural-and-deref.md
2018-11-08 10:58:55 -08:00
- [Inheritance](./web-sys/inheritance.md)
guide: Add a user-facing `web-sys` section
2018-09-10 17:51:44 -07:00
guide: Add documentation for testing with `wasm-bindgen-test`
2018-09-12 13:14:39 -07:00
- [Testing with `wasm-bindgen-test`](./wasm-bindgen-test/index.md)
- [Usage](./wasm-bindgen-test/usage.md)
- [Writing Asynchronous Tests](./wasm-bindgen-test/asynchronous-tests.md)
- [Testing in Headless Browsers](./wasm-bindgen-test/browsers.md)
- [Continuous Integration](./wasm-bindgen-test/continuous-integration.md)
- [Contributing to `wasm-bindgen`](./contributing/index.md)
guide: Fix nesting of contributing pages
2018-09-10 15:32:29 -07:00
- [Testing](./contributing/testing.md)
- [Internal Design](./contributing/design/index.md)
- [JS Objects in Rust](./contributing/design/js-objects-in-rust.md)
- [Exporting a function to JS](./contributing/design/exporting-rust.md)
- [Exporting a struct to JS](./contributing/design/exporting-rust-struct.md)
- [Importing a function from JS](./contributing/design/importing-js.md)
- [Importing a class from JS](./contributing/design/importing-js-struct.md)
- [Rust Type conversions](./contributing/design/rust-type-conversions.md)
- [Types in `wasm-bindgen`](./contributing/design/describe.md)
- [`js-sys`](./contributing/js-sys/index.md)
- [Testing](./contributing/js-sys/testing.md)
- [Adding More APIs](./contributing/js-sys/adding-more-apis.md)
- [`web-sys`](./contributing/web-sys/index.md)
- [Overview](./contributing/web-sys/overview.md)
- [Testing](./contributing/web-sys/testing.md)
- [Logging](./contributing/web-sys/logging.md)
- [Supporting More Web APIs](./contributing/web-sys/supporting-more-web-apis.md)
- [Publishing](./contributing/publishing.md)
- [Team](./contributing/team.md)
Reference in New Issue Copy Permalink