Request expanded documentation on implementing `trait Header`
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- rust
- Domain
- documentation
Research direction
Start with the linked impl Header for Dnt example in the headers documentation and trace the documented decode and encode APIs. Clarify iterator contents, unconsumed values, multiple emitted values, and whether encoding and decoding are symmetrical. Done means the documentation answers each of the listed questions.
Written by the indexing model from the issue text.
Description
The impl Header for Dnt example is a good start, but it doesn't explain the actual semantics of the iterator-based design.
Example questions which would be nice to have answered in the documentation:
- Under what circumstances will the iterator provided to
fn decodecontain more than one value? - If a
decodeimplementation does not consume the provided iterator entirely, what happens to the remaining values?- Are they re-used to produce a new instance?
- Are they just discarded?
- Under what circumstances is it reasonable to emit more than one value in
fn encode? - Are the
encodeanddecodecircumstances symmetrical?
- Dominant language
- Rust
- Stars
- 200
- Forks
- 107
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from hyperium/headers
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Difficulty 3/5 1-2 days Newbie friendliness 78/100
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Link support Open
Difficulty 4/5 3-5 days Newbie friendliness 38/100
All issues in hyperium/headers
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
issue
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
agentic-workflows
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
web-infra-dev/rspack#15847 ·