akka/akka-http

Clarify difference in docs between EntityStreamingSupport for any source and low-level Source[ByteString, Any]

Aperta

#895 aperta il 23 feb 2017

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Scala (598 fork)batch import
1 - triagedhelp wantedt:docs

Metriche repository

Star
 (1311 stelle)
Metriche merge PR
 (Merge medio 1g 10h) (2 PR mergiate in 30 g)

Descrizione

As per the gitter discussion with @ktoso, it could be probably worth mentioning in the docs that EntityStreamingSupport is only needed to complete a route with a stream of "discrete elements" like for example json arrays or csv entries, while a low level byte stream could be simply sent back to the client doing something like:

complete(HttpEntity(contentType, byteStringSource))

Guida contributor

Direzione di ricerca
Il problema richiede di chiarire la documentazione per EntityStreamingSupport. Suggerisce che EntityStreamingSupport è necessario solo per lo streaming di elementi discreti come array JSON o voci CSV, mentre i flussi di byte di basso livello possono essere inviati direttamente utilizzando `complete(HttpEntity(contentType, byteStringSource))`. Esamina i file di documentazione nel repository akka http, probabilmente nella directory 'docs', e trova dove viene spiegato EntityStreamingSupport. Aggiungi una nota per distinguere il suo scopo dall'invio di flussi di byte grezzi. Il problema fa riferimento a una discussione su Gitter con @ktoso, che potrebbe fornire ulteriore contesto.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Akka HTTPScala basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80