Reorganize the "Canonical Built-ins" section of Explainer.md. #413
+388
−61
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
This moves the signatures for the canonical builtins out of prose paragraphs and into tables, which highlights them and simplifies the prose. This also adds "conceptual signatures". The canonical ABI signatures are useful when one is writing compilers or bindings generators or other tools, while the conceptual signatures are useful for people seeking to understand what these builtins do at a conceptual level, before thinking about how all the various values are lowered into `i32`s. And, the conceptual signatures in theory are independent of the ABI, so they could be reused when new ABIs are added. This is a follow-up to WebAssembly#407; I've re-added the `canon` ebpf for now, removed the "Binary encoding immediates" table rows, and tidied up the signatures to avoid using `...`.
lukewagner
reviewed
Nov 18, 2024
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
lann
reviewed
Nov 19, 2024
Co-authored-by: Lann <[email protected]>
lukewagner
reviewed
Nov 19, 2024
design/mvp/Explainer.md
Outdated
|
|
||
| | Synopsis | | | ||
| | -------------------------- | ----------------------------------------------------------- | | ||
| | Approximate WIT signature | `func<T>(stream: readable-stream<T>, buffer: readable-buffer<T>) -> read-status` | |
There was a problem hiding this comment.
Suggested change
| | Approximate WIT signature | `func<T>(stream: readable-stream<T>, buffer: readable-buffer<T>) -> read-status` | | |
| | Approximate WIT signature | `func<T>(stream: borrow<readable-stream<T>>, buffer: writable-buffer<T>) -> read-status` | |
There was a problem hiding this comment.
Why is the readable-stream<T> explicitly borrow, when writable-buffer<T> is not?
|
Thanks for this! I had been reading through the async content and compiling a list of questions before seeing this PR but I think they're mostly resolved here. |
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
Co-authored-by: Luke Wagner <[email protected]>
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.
This moves the signatures for the canonical builtins out of prose paragraphs and into tables, which highlights them and simplifies the prose.
This also adds "conceptual signatures". The canonical ABI signatures are useful when one is writing compilers or bindings generators or other tools, while the conceptual signatures are useful for people seeking to understand what these builtins do at a conceptual level, before thinking about how all the various values are lowered into
i32s.And, this PR introduces greater separation between the logical builtins and the way they appear in the canonical ABI, with the conceptual signatures, and with prose that puts canonical ABI details in their own paragraphs. In theory, this should make it easier to reuse the logical builtins when adding new ABIs.
This is a follow-up to #407; I've re-added the
canonebpf for now, removed the "Binary encoding immediates" table rows, and tidied up the signatures to avoid using....