From 7b7749cd7bd85fac6d490c20be06752ed69e8230 Mon Sep 17 00:00:00 2001 From: Jan Ypma Date: Wed, 26 Jul 2017 12:08:17 +0200 Subject: [PATCH] Fix #23165: Update StreamConverters.fromInputStream docs to reflect reality --- .../scala/akka/stream/javadsl/StreamConverters.scala | 12 ++++++++---- .../akka/stream/scaladsl/StreamConverters.scala | 6 ++++-- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/akka-stream/src/main/scala/akka/stream/javadsl/StreamConverters.scala b/akka-stream/src/main/scala/akka/stream/javadsl/StreamConverters.scala index 71cba30fdf..db71fbc078 100644 --- a/akka-stream/src/main/scala/akka/stream/javadsl/StreamConverters.scala +++ b/akka-stream/src/main/scala/akka/stream/javadsl/StreamConverters.scala @@ -89,8 +89,10 @@ object StreamConverters { /** * Creates a Source from an [[java.io.InputStream]] created by the given function. - * Emitted elements are `chunkSize` sized [[akka.util.ByteString]] elements, - * except the final element, which will be up to `chunkSize` in size. + * Emitted elements are up to `chunkSize` sized [[akka.util.ByteString]] elements. + * The actual size of emitted elements depends how much data the underlying + * [[java.io.InputStream]] returns on each read invocation. Such chunks will + * never be larger than chunkSize though. * * You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or * set it for a given Source by using [[akka.stream.ActorAttributes]]. @@ -104,8 +106,10 @@ object StreamConverters { /** * Creates a Source from an [[java.io.InputStream]] created by the given function. - * Emitted elements are [[ByteString]] elements, chunked by default by 8192 bytes, - * except the last element, which will be up to 8192 in size. + * Emitted elements are up to 8192 bytes sized [[akka.util.ByteString]] elements. + * The actual size of emitted elements depends how much data the underlying + * [[java.io.InputStream]] returns on each read invocation. Such chunks will + * never be larger than chunkSize though. * * You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or * set it for a given Source by using [[akka.stream.ActorAttributes]]. diff --git a/akka-stream/src/main/scala/akka/stream/scaladsl/StreamConverters.scala b/akka-stream/src/main/scala/akka/stream/scaladsl/StreamConverters.scala index 5657ec5e7a..a2a15fd8c8 100644 --- a/akka-stream/src/main/scala/akka/stream/scaladsl/StreamConverters.scala +++ b/akka-stream/src/main/scala/akka/stream/scaladsl/StreamConverters.scala @@ -29,8 +29,10 @@ object StreamConverters { /** * Creates a Source from an [[InputStream]] created by the given function. - * Emitted elements are `chunkSize` sized [[akka.util.ByteString]] elements, - * except the final element, which will be up to `chunkSize` in size. + * Emitted elements are up to `chunkSize` sized [[akka.util.ByteString]] elements. + * The actual size of emitted elements depends how much data the underlying + * [[java.io.InputStream]] returns on each read invocation. Such chunks will + * never be larger than chunkSize though. * * You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or * set it for a given Source by using [[akka.stream.ActorAttributes]].