Document support for Option<RustStruct> #2821
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Globidev
commented
Feb 27, 2022
Comment on lines
-16
to
+20
| named_struct_by_value(namedStruct); | ||
| named_struct_by_shared_ref(namedStruct); | ||
| named_struct_by_exclusive_ref(namedStruct); | ||
| named_struct_by_value(namedStruct); |
There was a problem hiding this comment.
Note: I switched the by_value call at the end because calling it actually invalidates the underlying pointer (since it's supposed to be moved on the rust side), meaning calling named_struct_by_shared_ref or named_struct_by_exclusive_ref afterwards would produce an error
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While working on a project of my own I intuitively attempted to return an
Option<MyRustType>from a#[wasm_bindgen]annotated function and it worked as expected.I later realized that support for that is not currently documented in the docs.
The relevant page on the official website even appear to explicitly say that it is not supported:
I then found out about PR #1275 which seems to implement both
OptionIntoWasmAbiandOptionFromWasmAbifor any#[wasm_bindgen]annotated rust struct. If I'm understanding everything correctly, then those two columns should be switched toYes.This PR adjusts the markdown to reflect the support for
Option<RustStruct>in both parameter and return type position while also adding some use cases in the relevant rust and javascript examples.