kitecore/io.github.yuroyami.kitecore/ProgressFuture

ProgressFuture

interface ProgressFuture<out T> : Deferred<T>

A Deferred that also exposes live progress.

Every Deferred member works here: await(), cancel(), awaitAll(...), and onAwait. In addition, progress is a conflated StateFlow of the latest Progress, observable from Compose via progress.collectAsState().

Apply progress policy such as throttling or monotonic bars with a Flow operator, for example progress.sample(100.milliseconds).

Create one with asyncWithProgress, or adapt an existing pair with withProgress. The intended granularity is one ProgressFuture per user-visible operation such as opening a document or downloading a file, not per inner step.

Properties

abstract val children: Sequence<Job>

abstract val isActive: Boolean

abstract val isCancelled: Boolean

abstract val isCompleted: Boolean

abstract val key: CoroutineContext.Key<*>

abstract val onAwait: SelectClause1<T>

abstract val onJoin: SelectClause0

@ExperimentalCoroutinesApi

abstract val parent: Job?

abstract val progress: StateFlow<Progress>

Latest progress. Starts indeterminate; set to fraction = 1f on success.

Functions

@InternalCoroutinesApi

abstract fun attachChild(child: ChildJob): ChildHandle

abstract suspend fun await(): T

suspend fun <T> Deferred<T>.awaitOrDefault(timeout: Duration, default: T): T

Awaits this deferred value and returns default if timeout elapses first.

suspend fun <T> Deferred<T>.awaitOrNull(timeout: Duration): T?

Awaits this deferred value and returns null if timeout elapses first.

abstract fun cancel(cause: CancellationException?)

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

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

getCancellationException

@InternalCoroutinesApi

abstract fun getCancellationException(): CancellationException

@ExperimentalCoroutinesApi

abstract fun getCompleted(): T

getCompletionExceptionOrNull

@ExperimentalCoroutinesApi

abstract fun getCompletionExceptionOrNull(): Throwable?

invokeOnCompletion

abstract fun invokeOnCompletion(handler: CompletionHandler): DisposableHandle

@InternalCoroutinesApi

abstract fun invokeOnCompletion(onCancelling: Boolean, invokeImmediately: Boolean, handler: CompletionHandler): DisposableHandle

abstract suspend fun join()

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

open operator fun plus(context: CoroutineContext): CoroutineContext

open operator fun ~~plus~~(other: Job): Job

abstract fun start(): Boolean

fun <T> Deferred<T>.withProgress(progress: StateFlow<Progress>): ProgressFuture<T>

Adapts an existing Deferred and an external progress StateFlow into a ProgressFuture.