The automatic replacement produces Markdown that caused the paradox task in sbt to timeout or event fail. So
this commit removes some operators with outpu too complex:
- ignored operators:
"ask.md",
"alsoTo.md",
"batchWeighted.md",
"buffer.md",
"actorRef.md",
"collect.md",
"collection.md",
"combine.md",
"completionTimeout.md",
"concat.md",
"from.md",
"fromMaterializer.md",
"map.md",
"merge.md",
"queue.md",
"log.md", // too many overloads, breaks `paradox` task
"throttle.md", // too many overloads, breaks `paradox` task
"idleTimeout.md", // too many overloads, breaks `paradox` task
"setup.md",
"watch.md",
"withBackoff.md",
"zip.md",
"zipWith.md",
"actorRefWithBackpressure.md"
- Ignored class when FQCN contains: Implicits, FlowOpsMat, SubSource, FlowOps, SubFlow, WithContext, DelayStrategy
- some extra manual cleanup on the committed operators.
This commit is contained in:
Ignasi Marimon-Clos
parent
4f667de73d
commit
0e7bce7bae
114 changed files with 173 additions and 461 deletions
|
|
@ -4,13 +4,10 @@ Turns a Source into a SourceWithContext which can propagate a context per elemen
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #asSourceWithContext }
|
||||
@apidoc[Source.asSourceWithContext](Source) { scala="#asSourceWithContext[Ctx](f:Out=>Ctx):akka.stream.scaladsl.SourceWithContext[Out,Ctx,Mat]" java="#asSourceWithContext(akka.japi.function.Function)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Send the single value of the `CompletionStage` when it completes and there is de
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-java }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #completionStage }
|
||||
@apidoc[Source.completionStage](Source$) { scala="#completionStage[T](completionStage:java.util.concurrent.CompletionStage[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#completionStage(java.util.concurrent.CompletionStage)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Stream iterator in cycled manner.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #cycle }
|
||||
@apidoc[Source.cycle](Source$) { scala="#cycle[T](f:()=>Iterator[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#cycle(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Complete right away without ever emitting any elements.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #empty }
|
||||
@apidoc[Source.empty](Source$) { scala="#empty[T]:akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#empty()" java="#empty(java.lang.Class)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Fail directly with a user specified exception.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #failed }
|
||||
@apidoc[Source.failed](Source$) { scala="#failed[T](cause:Throwable):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#failed(java.lang.Throwable)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Deprecated by @ref:[`Source.completionStage`](completionStage.md).
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromCompletionStage }
|
||||
@apidoc[Source.fromCompletionStage](Source$) { scala="#fromCompletionStage[T](future:java.util.concurrent.CompletionStage[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#fromCompletionStage(java.util.concurrent.CompletionStage)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Deprecated by @ref[`Source.future`](future.md).
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromFuture }
|
||||
@apidoc[Source.fromFuture](Source$) { scala="#fromFuture[T](future:scala.concurrent.Future[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Deprecated by @ref:[`Source.futureSource`](futureSource.md).
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromFutureSource }
|
||||
@apidoc[Source.fromFutureSource](Source$) { scala="#fromFutureSource[T,M](future:scala.concurrent.Future[akka.stream.Graph[akka.stream.SourceShape[T],M]]):akka.stream.scaladsl.Source[T,scala.concurrent.Future[M]]" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Stream the values from an `Iterator`, requesting the next value when there is de
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromIterator }
|
||||
@apidoc[Source.fromIterator](Source$) { scala="#fromIterator[T](f:()=>Iterator[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#fromIterator(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Stream the values from a Java 8 `Stream`, requesting the next value when there i
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #fromJavaStream }
|
||||
@apidoc[StreamConverters.fromJavaStream](StreamConverters$) { scala="#fromJavaStream[T,S<:java.util.stream.BaseStream[T,S]](stream:()=>java.util.stream.BaseStream[T,S]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#fromJavaStream(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,9 @@ Send the single value of the `Future` when it completes and there is demand.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #future }
|
||||
|
||||
@@@
|
||||
@apidoc[Source.future](Source$) { scala="#future[T](futureElement:scala.concurrent.Future[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" }
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Streams the elements of the given future source once it successfully completes.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #futureSource }
|
||||
@apidoc[Source.futureSource](Source$) { scala="#futureSource[T,M](futureSource:scala.concurrent.Future[akka.stream.scaladsl.Source[T,M]]):akka.stream.scaladsl.Source[T,scala.concurrent.Future[M]]" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Deprecated by @ref:[`Source.lazySource`](lazySource.md).
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #lazily }
|
||||
@apidoc[Source.lazily](Source$) { scala="#lazily[T,M](create:()=>akka.stream.scaladsl.Source[T,M]):akka.stream.scaladsl.Source[T,scala.concurrent.Future[M]]" java="#lazily(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,9 @@ Defers creation of a future of a single element source until there is demand.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #lazyFuture }
|
||||
|
||||
@@@
|
||||
@apidoc[Source.lazyFuture](Source$) { scala="#lazyFuture[T](create:()=>scala.concurrent.Future[T]):akka.stream.scaladsl.Source[T,akka.NotUsed]" }
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Defers creation and materialization of a `Source` until there is demand.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #lazyFutureSource }
|
||||
@apidoc[Source.lazyFutureSource](Source$) { scala="#lazyFutureSource[T,M](create:()=>scala.concurrent.Future[akka.stream.scaladsl.Source[T,M]]):akka.stream.scaladsl.Source[T,scala.concurrent.Future[M]]" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Defers creation of a single element source until there is demand.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #lazySingle }
|
||||
@apidoc[Source.lazySingle](Source$) { scala="#lazySingle[T](create:()=>T):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#lazySingle(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Defers creation and materialization of a `Source` until there is demand.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #lazySource }
|
||||
@apidoc[Source.lazySource](Source$) { scala="#lazySource[T,M](create:()=>akka.stream.scaladsl.Source[T,M]):akka.stream.scaladsl.Source[T,scala.concurrent.Future[M]]" java="#lazySource(akka.japi.function.Creator)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Create a source that emits once the materialized @scala[`Promise`] @java[`Comple
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #maybe }
|
||||
@apidoc[Source.maybe](Source$) { scala="#maybe[T]:akka.stream.scaladsl.Source[T,scala.concurrent.Promise[Option[T]]]" java="#maybe()" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ A periodical repetition of an arbitrary object.
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #tick }
|
||||
@apidoc[Source.tick](Source$) { scala="#tick[T](initialDelay:scala.concurrent.duration.FiniteDuration,interval:scala.concurrent.duration.FiniteDuration,tick:T):akka.stream.scaladsl.Source[T,akka.actor.Cancellable]" java="#tick(java.time.Duration,java.time.Duration,java.lang.Object)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Stream the result of a function as long as it returns a @scala[`Some`] @java[non
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfold }
|
||||
@apidoc[Source.unfold](Source$) { scala="#unfold[S,E](s:S)(f:S=>Option[(S,E)]):akka.stream.scaladsl.Source[E,akka.NotUsed]" java="#unfold(java.lang.Object,akka.japi.function.Function)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Just like `unfold` but the fold function returns a @scala[`Future`] @java[`Compl
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfoldAsync }
|
||||
@apidoc[Source.unfoldAsync](Source$) { scala="#unfoldAsync[S,E](s:S)(f:S=>scala.concurrent.Future[Option[(S,E)]]):akka.stream.scaladsl.Source[E,akka.NotUsed]" java="#unfoldAsync(java.lang.Object,akka.japi.function.Function)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Wrap any resource that can be opened, queried for next element (in a blocking wa
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfoldResource }
|
||||
@apidoc[Source.unfoldResource](Source$) { scala="#unfoldResource[T,S](create:()=>S,read:S=>Option[T],close:S=>Unit):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#unfoldResource(akka.japi.function.Creator,akka.japi.function.Function,akka.japi.function.Procedure)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
|
|
@ -4,13 +4,10 @@ Wrap any resource that can be opened, queried for next element and closed in an
|
|||
|
||||
@ref[Source operators](../index.md#source-operators)
|
||||
|
||||
@@@div { .group-scala }
|
||||
|
||||
## Signature
|
||||
|
||||
@@signature [Source.scala](/akka-stream/src/main/scala/akka/stream/scaladsl/Source.scala) { #unfoldResourceAsync }
|
||||
@apidoc[Source.unfoldResourceAsync](Source$) { scala="#unfoldResourceAsync[T,S](create:()=>scala.concurrent.Future[S],read:S=>scala.concurrent.Future[Option[T]],close:S=>scala.concurrent.Future[akka.Done]):akka.stream.scaladsl.Source[T,akka.NotUsed]" java="#unfoldResourceAsync(akka.japi.function.Creator,akka.japi.function.Function,akka.japi.function.Function)" }
|
||||
|
||||
@@@
|
||||
|
||||
## Description
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue