akka/akka-http

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

Open

#895 opened on 2017年2月23日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docs

説明

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))

コントリビューターガイド

技術スタック
なし
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
ScalaAkka HTTP basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
The issue requests clarifying the documentation for EntityStreamingSupport. It suggests that EntityStreamingSupport is only needed for streaming discrete elements like JSON arrays or CSV entries, while low level byte streams can be sent directly using `complete(HttpEntity(contentType, byteStringSource))`. Look into the documentation files in the akka http repository, likely under the 'docs' directory, and find where EntityStreamingSupport is explained. Add a note to distinguish its purpose from sending raw byte streams. The issue references a Gitter discussion with @ktoso, which may provide more context.