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