redukt-core/com.daftmobile.redukt.core.coroutines/DispatchCoroutineScope

DispatchCoroutineScope

class DispatchCoroutineScope(coroutineScope: CoroutineScope) : DispatchClosure.Element, CoroutineScope

Default CoroutineScope associated with a store. By default, the store contains a MainScope and it can be replaced at store creation by adding it into a DispatchClosure. It can be accessed by coroutineScope extension property. Tools provided by this library most likely use this scope to launch a coroutine.

Constructors

fun DispatchCoroutineScope(context: CoroutineContext)

DispatchCoroutineScope

fun DispatchCoroutineScope(coroutineScope: CoroutineScope)

Types

Key

object Key : DispatchClosure.Key<DispatchCoroutineScope>

Functions

find

open override fun <T : DispatchClosure.Element> find(key: DispatchClosure.Key<T>): T?

Returns Element associated with the key or null.

get

open operator override fun <T : DispatchClosure.Element> get(key: DispatchClosure.Key<T>): T

Returns Element associated with the key or throws MissingClosureElementException.

minus

open operator override fun minus(key: DispatchClosure.Key<*>): DispatchClosure

Returns a closure without the element with a given key

plus

open operator fun plus(closure: DispatchClosure): DispatchClosure

Combines this closure with incoming closure. If both closures contain elements with the same keys, the ones from the incoming closure remain.

scatter

open override fun scatter(): Map<DispatchClosure.Key<*>, DispatchClosure.Element>

Returns elements form this DispatchClosure as a Map.

toString

open override fun toString(): String

Properties

coroutineContext

open override val coroutineContext: CoroutineContext

key

open override val key: DispatchCoroutineScope.Key

Key of this element.

Extensions

findOrElse

fun <T : DispatchClosure.Element> DispatchClosure.findOrElse(key: DispatchClosure.Key<T>, value: T): T

launchForeground

fun DispatchClosure.launchForeground(context: CoroutineContext = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend CoroutineScope.() -> Unit): Job

Launches a foreground job using this closure. By default, it's launched in a scope provided by DispatchCoroutineScope. This behaviour might be changed by dispatchJobIn or joinDispatchJob. Because this function uses local closure, calling it outside dispatch should not be done, because it might result in unexpected behaviour.

local

val DispatchClosure.local: DispatchClosure

Returns this closure with local changes.

registeringJob

inline fun DispatchClosure.registeringJob(closure: DispatchClosure = EmptyDispatchClosure, newFrame: Boolean = false, block: DispatchClosure.() -> Unit): Job

Runs block that must register a foreground job. It adds SingleForegroundJobRegistry to local closure to allow proper job registration. Local closure change creates a new frame if newFrame is true.

withLocalClosure

inline fun <T> DispatchClosure.withLocalClosure(closure: DispatchClosure, newFrame: Boolean = false, block: DispatchClosure.() -> T): T

Changes LocalClosureContainer with a given closure for a time of block execution.