WebAssembly / WebAssembly/WASI

Add record for `tuple<stream<u8>, future<result<_, error-code>>>`

Open
#753 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

P-cli
Dominant language
Rust
Stars
5.8k
Forks
333
Avg merge
2d 13h
Merged PRs (30d)
3

Description

This type is duplicated between stdout and stderr write-via-stream. I'd like to add some record type to hold these two items and associated documentation for how the two should be used together.

This type pattern also appears in other wasi interfaces (wasi-filesystem, wasi-http, more?), so a goal here would be to establish a convention to help implementers familiarity-wise.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the stdout and stderr write-via-stream interfaces and how their tuple type is currently declared. Compare the same pattern in wasi-filesystem and wasi-http to identify a consistent convention. Done means the duplicated type is represented by a shared record, its paired use is documented, and the convention is clear for implementers.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.