tree: 5585695113704829901bb77618510c7819f53611 [path history] [tgz]
  1. src/
  2. pom.xml
  3. README.md
kotlinx-coroutines-rx2/README.md

Module kotlinx-coroutines-rx2

Utilities for RxJava 2.x.

Coroutine builders:

NameResultScopeDescription
rxCompletableCompletableCoroutineScopeCold completable that starts coroutine on subscribe
rxSingleSingleCoroutineScopeCold single that starts coroutine on subscribe
rxObservableObservableProducerScopeCold observable that starts coroutine on subscribe

Suspending extension functions and suspending iteration:

NameDescription
CompletableSource.awaitAwaits for completion of the completable value
SingleSource.awaitAwaits for completion of the single value and returns it
ObservableSource.awaitFirstAwaits for the first value from the given observable
ObservableSource.awaitLastAwaits for the last value from the given observable
ObservableSource.awaitSingleAwaits for the single value from the given observable
ObservableSource.openSubscribes to observable and returns ReceiveChannel
ObservableSource.iteratorSubscribes to observable and returns ChannelIterator

Note, that Flowable is a subclass of Reactive Streams Publisher and extensions for it are covered by kotlinx-coroutines-reactive module.

Conversion functions:

NameDescription
Job.toCompletableConverts job to hot completable
Deferred.toSingleConverts deferred value to hot single
ReceiveChannel.toObservableConverts streaming channel to hot observable

Package kotlinx.coroutines.experimental.rx2

Utilities for RxJava 2.x.