alakazam.kotlin.core.FlowExtensions.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-core Show documentation

A set of useful functions and extensions for Kotlin development.

There is a newer version: 4.7.0

package alakazam.kotlin.core

import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.onEach
import kotlinx.coroutines.flow.transformWhile

/**
 * Performs the supplied [call] callback on every emission matching the [Expected] type. All values
 * are passed through as-is, regardless of the type.
 */
public inline fun  Flow.onEachOfType(
  crossinline call: suspend (Expected) -> Unit,
): Flow = onEach {
  if (it is Expected) {
    call(it)
  }
}

/**
 * An operator to take all values emitted by the subject [Flow], only stopping when [stopOn] returns
 * true. When this condition is reached, the offending emission ***WILL NOT*** be passed onto the
 * caller and the flow will be cancelled.
 */
public fun  Flow.takeUntilExclusive(stopOn: (T) -> Boolean): Flow = transformWhile {
  val shouldStop = !stopOn(it)
  if (shouldStop) {
    emit(it)
  }
  shouldStop
}

/**
 * An operator to take all values emitted by the subject [Flow], only stopping when [stopOn] returns
 * true. When this condition is reached, the offending emission ***WILL*** be passed onto the
 * caller and the flow will be cancelled.
 */
public fun  Flow.takeUntilInclusive(stopOn: (T) -> Boolean): Flow = transformWhile {
  emit(it)
  !stopOn(it)
}