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.