haskell-servant/servant

Add examples of using the streaming combinators to the cookbook

Open

#912 opened on Feb 27, 2018

View on GitHub
 (17 comments) (1 reaction) (0 assignees)Haskell (1,953 stars) (422 forks)batch import
documentationhelp wantedtutorial

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

Contributor guide

Tech stack
None
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Haskell knowledgeServant basicsStreaming libraries
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Examine the existing cookbook examples under 'doc/cookbook' in the servant repository to understand the pattern. Study the documentation of the 'pipes', 'conduit', and 'streaming' libraries to know how to generate/read streams. Implement examples for both topics mentioned in the issue, following the existing structure and ensuring the code compiles and tests pass. Update the cookbook index if necessary.