circuit-test/com.slack.circuit.test/CircuitReceiveTurbine

CircuitReceiveTurbine

interface CircuitReceiveTurbine<UiState : CircuitUiState> : ReceiveTurbine<UiState> (source)

A Circuit-specific extension to ReceiveTurbine with extra helper functions for Circuit testing.

This implementation of ReceiveTurbine slightly alters the behavior of awaitItem by only emitting items that are different from the previously emitted item.

Functions

asChannel

abstract fun asChannel(): ReceiveChannel<UiState>

awaitComplete

abstract suspend fun awaitComplete()

awaitError

abstract suspend fun awaitError(): Throwable

awaitEvent

abstract suspend fun awaitEvent(): Event<UiState>

awaitItem

abstract suspend fun awaitItem(): UiState

awaitUnchanged

abstract suspend fun awaitUnchanged()

Awaits the next item and asserts that it is unchanged from the previous emission. Essentially this is a sort of escape-hatch from the altered "distinct until changed" behavior of awaitItem in this implementation and can be used to more or less assert no change in state after the next recomposition.

cancel

abstract suspend fun cancel()

cancelAndConsumeRemainingEvents

abstract suspend fun cancelAndConsumeRemainingEvents(): List<Event<UiState>>

cancelAndIgnoreRemainingEvents

abstract suspend fun cancelAndIgnoreRemainingEvents()

ensureAllEventsConsumed

abstract fun ensureAllEventsConsumed()

expectMostRecentItem

abstract fun expectMostRecentItem(): UiState

expectNoEvents

abstract fun expectNoEvents()

skipItems

abstract suspend fun skipItems(count: Int)