kitecore/io.github.yuroyami.kitecore

Package-level declarations

Types

Identity of the host platform: its name, osVersion, deviceModel, and family. Read it from Platform.current.

enum PlatformFamily : Enum<PlatformFamily>

Coarse platform family used for when branching in shared code.

class Progress(fraction: Float?, val phase: String? = null)

An immutable snapshot of an operation's progress: a fraction and an optional phase label.

interface ProgressFuture<out T> : Deferred<T>

A Deferred that also exposes live progress.

interface ProgressScope : CoroutineScope

The receiver scope of an asyncWithProgress block: a CoroutineScope that can report progress and divide the remaining bar into sequential slices.

actual class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

actual class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

expect class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

actual class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

actual class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

actual class WeakRef<T : Any>(referred: T)

A weak reference to T. Holds its referent without preventing garbage collection.

class WebWorker

A Web Worker that runs a self-contained JavaScript job off the main thread on Kotlin/JS.

class WebWorker

A Web Worker that runs a self-contained JavaScript job off the main thread on Kotlin/Wasm (wasmJs).

WebWorkerException

class WebWorkerException(message: String) : RuntimeException

Thrown when a WebWorker job throws, the worker script fails to load (e.g. a syntax error in jobJs), or the worker is closed mid-call.

class WebWorkerException(message: String) : RuntimeException

Thrown when a WebWorker job throws, the worker script fails to load (e.g. a syntax error in jobJs), or the worker is closed mid-call.

Properties

actual val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

actual val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

expect val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

actual val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

actual val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

actual val ioDispatcher: CoroutineDispatcher

The CoroutineDispatcher for blocking and IO-bound work on the current target.

Functions

asyncWithProgress

fun <T> CoroutineScope.asyncWithProgress(context: CoroutineContext = EmptyCoroutineContext, start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend ProgressScope.() -> T): ProgressFuture<T>

Starts a coroutine like async and returns a ProgressFuture that reports its progress.

installIoDispatcher

actual fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

actual fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

expect fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

actual fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

actual fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

actual fun installIoDispatcher(dispatcher: CoroutineDispatcher)

Sets the CoroutineDispatcher that ioDispatcher resolves to on the web targets (js, wasmJs).

suspend fun runInWorker(jobJs: String, payload: String): String

Builds a worker, runs payload through jobJs, and then closes the worker.

suspend fun runInWorker(jobJs: String, payload: String): String

Builds a worker, runs payload through jobJs, and then closes the worker.

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

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