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 (422 forks)batch import
documentationhelp wantedtutorial

Repository metrics

Stars
 (1,953 stars)
PR merge metrics
 (Avg merge 5h 49m) (2 merged PRs in 30d)

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

Research direction
Examine the existing cookbook in servant's documentation and write examples demonstrating streaming with pipes, conduit, and streaming libraries, including custom strategies for chunked file serving.
Tech stack
haskell
Domain
backendapi
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Haskellservantstreaming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60