Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Request expanded documentation on implementing `trait Header`

Abierto
#144 1 comentario 2 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
rust

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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?
Lenguaje dominante
Rust
Estrellas
200
Forks
108
Merge medio
3 d 2 h
PR fusionados (30 d)
2

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de hyperium/headers

Todos los issues de hyperium/headers

Issues similares

Más issues de Rust

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.