haskell-servant/servant

Add examples of using the streaming combinators to the cookbook

Open

#912 aberto em 27 de fev. de 2018

Ver no GitHub
 (17 comments) (1 reaction) (0 assignees)Haskell (422 forks)batch import
documentationhelp wantedtutorial

Métricas do repositório

Stars
 (1.953 stars)
Métricas de merge de PR
 (Mesclagem média 23h 44m) (4 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Examine os exemplos existentes do cookbook em 'doc/cookbook' no repositório servant para entender o padrão. Estude a documentação das bibliotecas 'pipes', 'conduit' e 'streaming' para saber como gerar/ler streams. Implemente exemplos para ambos os tópicos mencionados na issue, seguindo a estrutura existente e garantindo que o código compile e os testes passem. Atualize o índice do cookbook, se necessário.
Pilha de tecnologia
None
Domain
documentationbackend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Haskell knowledgeServant basicsStreaming libraries
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
20