haskell-servant/servant

Add examples of using the streaming combinators to the cookbook

Open

#912 ouverte le 27 févr. 2018

Voir sur GitHub
 (17 commentaires) (1 réaction) (0 assignés)Haskell (422 forks)batch import
documentationhelp wantedtutorial

Métriques du dépôt

Stars
 (1 953 stars)
Métriques de merge PR
 (Merge moyen 23h 44m) (4 PRs mergées en 30 j)

Description

Obvious topics to be covered:

  • generating/reading streams with pipes, conduit, streaming
  • defining custom strategies that e.g use fixed-size chunks and no delimiters for, say, serving files local to the server in a streaming fashion without forcing the client to read it all in memory

Guide contributeur

Direction de recherche
Examinez les exemples existants du cookbook sous 'doc/cookbook' dans le dépôt servant pour comprendre le modèle. Étudiez la documentation des bibliothèques 'pipes', 'conduit' et 'streaming' pour savoir comment générer/lire des flux. Implémentez des exemples pour les deux sujets mentionnés dans l'issue, en suivant la structure existante et en veillant à ce que le code compile et que les tests passent. Mettez à jour l'index du cookbook si nécessaire.
Stack technique
Aucun
Domaine
documentationbackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Haskell knowledgeServant basicsStreaming libraries
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
20