-
Notifications
You must be signed in to change notification settings - Fork 256
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create witx-type-representation.md #318
base: main
Are you sure you want to change the base?
Create witx-type-representation.md #318
Conversation
3ca198e
to
19a57f7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool! This looks like a great start documenting a part of witx which is currently undocumented!
Could you add a link to this from here? https://github.com/WebAssembly/WASI/blob/master/docs/witx.md
One other thing which may be useful to mention in the intro; the representations of these types are exposed when used with linear memory, however witx is also meant to be used in the future in non-linear-memory contexts as well, in which case the representation is opaque.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
I'm sure folks will find this useful.
I wonder if it makes sense to integrate this into the existing docs somewhere? Or at least be linked to from witx-generated docs? @pchickey
my bad on taking forever lol |
iovec | ||
|
||
buf: Pointer<u8> @ offset 0 | ||
buf_len: size @ offset 4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The offset may be 4 or 8 depends on sizeof pointer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that the docs don't mention this distinction - I'm unsure if it's within scope of this PR to mention it if the docs don't.
ae8b5ac
to
0c4b9ec
Compare
0c4b9ec
to
ca38d96
Compare
Apologies for it having been a while since I've worked on this. I tried to update the terminology to be more in-line with what's currently in use, but I might've glossed something over. |
This document summarizes the types that can be found in the phaser snapshots. The goal of this is that it should be a one-stop shop for people looking to implement ABI compatibility with certain types. This PR was created to resolve one of the issues brought up with #316
Points of improvement before merging:
subscription_u
would be hard to read on mobile