kotlinx-coroutines-core/kotlinx.coroutines.flow/asFlow

asFlow

fun <T> () -> T.asFlow(): Flow<T>(source)

Creates a cold flow that produces a single value from the given functional type.

fun <T> suspend () -> T.asFlow(): Flow<T>(source)

Creates a cold flow that produces a single value from the given functional type.

Example of usage:

suspend fun remoteCall(): R = ...
fun remoteCallFlow(): Flow<R> = ::remoteCall.asFlow()
Content copied to clipboard
fun <T> Iterable<T>.asFlow(): Flow<T>(source)

Creates a cold flow that produces values from the given iterable.

fun <T> Iterator<T>.asFlow(): Flow<T>(source)

Creates a cold flow that produces values from the given iterator.

fun <T> Sequence<T>.asFlow(): Flow<T>(source)

Creates a cold flow that produces values from the given sequence.

fun <T> Array<T>.asFlow(): Flow<T>(source)
fun LongArray.asFlow(): Flow<Long>(source)

Creates a cold flow that produces values from the given array. The flow being cold means that the array components are read every time a terminal operator is applied to the resulting flow.

fun IntArray.asFlow(): Flow<Int>(source)

Creates a cold flow that produces values from the array. The flow being cold means that the array components are read every time a terminal operator is applied to the resulting flow.

fun IntRange.asFlow(): Flow<Int>(source)
fun LongRange.asFlow(): Flow<Long>(source)

Creates a flow that produces values from the range.

fun <T> BroadcastChannel<T>.asFlow(): Flow<T>(source)

Deprecated (with error)

'BroadcastChannel' is obsolete and all corresponding operators are deprecated in the favour of StateFlow and SharedFlow

Represents the given broadcast channel as a hot flow. Every flow collector will trigger a new broadcast channel subscription.

Cancellation semantics

  1. Flow consumer is cancelled when the original channel is cancelled.

  2. Flow consumer completes normally when the original channel completes (~is closed) normally.

  3. If the flow consumer fails with an exception, subscription is cancelled.