FlowTurbine

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

Functions

cancel

abstract suspend 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

abstract suspend fun expectComplete()

Assert that the next event received was the flow completing.

expectError

abstract suspend fun expectError(): Throwable

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

expectEvent

abstract suspend fun expectEvent(): Event<T>

Assert that an event was received and return it.

expectItem

abstract suspend fun expectItem(): T

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

expectNoEvents

abstract fun expectNoEvents()

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

timeout

Duration that expectItem, expectComplete, and expectError will wait for an event before throwing a timeout exception.