commonMain.io.mockative.kontinuity.KontinuityScope.kt Maven / Gradle / Ivy

Go to download

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

Effortless use `suspend` and `Flow<T>` in non-JVM Kotlin Multiplatform targets.

The newest version!

package io.mockative.kontinuity

import kotlinx.coroutines.CoroutineScope
import kotlin.native.concurrent.SharedImmutable

/**
 * Designates a top-level property as the [CoroutineScope] of coroutines launched from within that
 * file, or as the default [CoroutineScope] used for all coroutines launched by Kontinuity, unless
 * otherwise overwritten in a file. The property annotated with this annotated must also be
 * annotated with [SharedImmutable].
 */
@Target(AnnotationTarget.PROPERTY)
@Retention(AnnotationRetention.SOURCE)
annotation class KontinuityScope(
    /**
     * Specifies whether this is the default [CoroutineScope]. Only one property in a source set
     * may be the default scope. The default value is `false`.
     */
    val default: Boolean = false,
)