raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Replace FoldSink with sink in the documentation (#31036)

Browse source
This commit is contained in:
Nitika Agarwal 2022-01-07 15:19:12 +05:30 • committed by GitHub
parent 4a1cc0c14c
commit 0211055a1d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
akka-docs/src/main/paradox/stream/stream-flows-and-basics.md
View file

@ -104,7 +104,7 @@ In the above example, we used `toMat` to indicate that we want to transform the
sink, and we used the convenience function `Keep.right` to say that we are only interested in the materialized value sink, and we used the convenience function `Keep.right` to say that we are only interested in the materialized value
of the sink. of the sink.
In our example, the `FoldSink` materializes a value of type `Future` which will represent the result In our example, the `Sink.fold` materializes a value of type `Future` which will represent the result
of the folding process over the stream. In general, a stream can expose multiple materialized values, of the folding process over the stream. In general, a stream can expose multiple materialized values,
but it is quite common to be interested in only the value of the Source or the Sink in the stream. For this reason but it is quite common to be interested in only the value of the Source or the Sink in the stream. For this reason
there is a convenience method called `runWith()` available for `Sink`, `Source` or `Flow` requiring, respectively, there is a convenience method called `runWith()` available for `Sink`, `Source` or `Flow` requiring, respectively,
@ -119,7 +119,7 @@ After running (materializing) the `RunnableGraph` we get a special container obj
sources and sinks are able to put specific objects into this map. Whether they put something in or not is implementation sources and sinks are able to put specific objects into this map. Whether they put something in or not is implementation
dependent. dependent.
For example a `FoldSink` will make a `CompletionStage` available in this map which will represent the result For example, a `Sink.fold` will make a `CompletionStage` available in this map which will represent the result
of the folding process over the stream. In general, a stream can expose multiple materialized values, of the folding process over the stream. In general, a stream can expose multiple materialized values,
but it is quite common to be interested in only the value of the Source or the Sink in the stream. For this reason but it is quite common to be interested in only the value of the Source or the Sink in the stream. For this reason
there is a convenience method called `runWith()` available for `Sink`, `Source` or `Flow` requiring, respectively, there is a convenience method called `runWith()` available for `Sink`, `Source` or `Flow` requiring, respectively,