FlowTurbine

Represents active collection on a source Flow which buffers item emissions, completion, and/or errors as events for consuming.

Functions

awaitComplete

abstract suspend fun awaitComplete()

Assert that the next event received was the flow completing.

awaitError

abstract suspend fun awaitError(): Throwable

Assert that the next event received was an error terminating the flow.

awaitEvent

abstract suspend fun awaitEvent(): Event<T>

Assert that an event was received and return it.

awaitItem

abstract suspend fun awaitItem(): T

Assert that the next event received was an item and return it.

cancel

abstract fun cancel()

Cancel collecting events from the source Flow.

cancelAndConsumeRemainingEvents

Cancel collecting events from the source Flow.

cancelAndIgnoreRemainingEvents

Cancel collecting events from the source Flow and ignore any events which have already been received.

expectComplete

open suspend fun expectComplete()

expectError

open suspend fun expectError(): Throwable

expectEvent

open suspend fun expectEvent(): Event<T>

expectItem

open suspend fun expectItem(): T

expectMostRecentItem

Returns the most recent item that has already been received.

expectNoEvents

abstract fun expectNoEvents()

Assert that there are no unconsumed events which have already been received.

timeout

Duration that awaitItem, awaitComplete, awaitError, and awaitEvent will wait before throwing a timeout exception.