Progress (Coroutines compatibility)/opensavvy.progress.coroutines/CoroutineProgressReporter

CoroutineProgressReporter

class CoroutineProgressReporter(reporter: ProgressReporter) : AbstractCoroutineContextElement, ProgressReporter(source)

Captures progress information about the currently running task.

KotlinX.Coroutines uses a CoroutineContext object throughout suspend functions to store information about the currently-running task. To report the current Progress of a coroutine, CoroutineProgressReporter is added to its context.

Constructors

constructor(reporter: ProgressReporter)

Types

Key

object Key : CoroutineContext.Key<CoroutineProgressReporter>

Properties

key

open override val key: CoroutineContext.Key<*>

Functions

asCoroutineContext

fun ProgressReporter.asCoroutineContext(): CoroutineProgressReporter

Wraps this ProgressReporter into a CoroutineProgressReporter so it can be inserted in a CoroutineContext.

fold

open override fun <R> fold(initial: R, operation: (R, CoroutineContext.Element) -> R): R

get

open operator override fun <E : CoroutineContext.Element> get(key: CoroutineContext.Key<E>): E?

minusKey

open override fun minusKey(key: CoroutineContext.Key<*>): CoroutineContext

plus

open operator fun plus(context: CoroutineContext): CoroutineContext

report

open override fun report(progress: Progress)

toString

open override fun toString(): String