Adding example of fold for sink #25468

This commit is contained in:
Muskan Gupta 2020-09-21 21:31:14 +05:30 committed by GitHub
parent b7640c3261
commit ac648a5940
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 0 deletions

View file

@ -18,6 +18,16 @@ Materializes into a @scala[`Future`] @java[`CompletionStage`] that will complete
This operator allows combining values into a result without a global mutable state by instead passing the state along
between invocations.
## Example
This example reads the numbers from a source and do some calculation in the flow part and in the end uses Sink.fold and adds the incoming elements.
Scala
: @@snip [Fold.scala](/akka-docs/src/test/scala/docs/stream/operators/sink/Fold.scala) { #fold }
Java
: @@snip [SinkDocExamples.java](/akka-docs/src/test/java/jdocs/stream/operators/SinkDocExamples.java) { #fold }
## Reactive Streams semantics
@@@div { .callout }

View file

@ -105,6 +105,15 @@ public class SinkDocExamples {
// #lastOption-operator-example
}
static void foldExample() {
// #fold
Source<Integer, NotUsed> source = Source.range(1, 100);
CompletionStage<Integer> sum =
source.runWith(Sink.fold(0, (res, element) -> res + element), system);
sum.thenAccept(System.out::println);
// #fold
}
static void ignoreExample() {
// #ignore
Source<String, NotUsed> lines = readLinesFromFile();

View file

@ -0,0 +1,23 @@
/*
* Copyright (C) 2020 Lightbend Inc. <https://www.lightbend.com>
*/
package docs.stream.operators.sink
import akka.actor.ActorSystem
import akka.stream.scaladsl.{ Sink, Source }
import scala.concurrent.{ ExecutionContextExecutor, Future }
object Fold {
implicit val system: ActorSystem = ???
implicit val ec: ExecutionContextExecutor = system.dispatcher
def foldExample: Future[Unit] = {
//#fold
val source = Source(1 to 100)
val result: Future[Int] = source.runWith(Sink.fold(0)((acc, element) => acc + element))
result.map(println)
//5050
//#fold
}
}