akka/akka-http

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

Open

#895 建立於 2017年2月23日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Scala (1,311 star) (598 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.