Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Request expanded documentation on implementing `trait Header`

Aperta
#144 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 decode contain more than one value?
  • If a decode implementation 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 encode and decode circumstances symmetrical?
Lingua principale
Rust
Stelle
200
Fork
107
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperium/headers

Tutte le issue di hyperium/headers

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.