akka/akka-http

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

開放

#895 建立於 2017年2月23日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人)Scala (598 個分叉)batch import
1 - triagedhelp wantedt:docs

倉庫指標

星標
 (1,311 顆星)
PR 合併指標
 (平均合併 1天 10小時) (30 天內合併 2 個 PR)

描述

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

貢獻者指南

研究方向
該問題要求澄清 EntityStreamingSupport 的文件。它指出 EntityStreamingSupport 僅適用於串流離散元素（如 JSON 陣列或 CSV 條目），而低階的位元組串流可以直接使用 `complete(HttpEntity(contentType, byteStringSource))` 發送。請查看 akka http 儲存庫中的文件檔案，很可能在 'docs' 目錄下，找到解釋 EntityStreamingSupport 的地方。新增說明以區分其用途與發送原始位元組串流。該問題引用了與 @ktoso 的 Gitter 討論，可能提供更多上下文。
技術棧
無
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Akka HTTPScala basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80