Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Runnable a fun interface #4261

Merged
merged 1 commit into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions kotlinx-coroutines-core/api/kotlinx-coroutines-core.api
Original file line number Diff line number Diff line change
Expand Up @@ -561,10 +561,6 @@ public final class kotlinx/coroutines/ParentJob$DefaultImpls {
public static fun plus (Lkotlinx/coroutines/ParentJob;Lkotlinx/coroutines/Job;)Lkotlinx/coroutines/Job;
}

public final class kotlinx/coroutines/RunnableKt {
public static final fun Runnable (Lkotlin/jvm/functions/Function0;)Ljava/lang/Runnable;
}

public final class kotlinx/coroutines/SupervisorKt {
public static final fun SupervisorJob (Lkotlinx/coroutines/Job;)Lkotlinx/coroutines/CompletableJob;
public static final synthetic fun SupervisorJob (Lkotlinx/coroutines/Job;)Lkotlinx/coroutines/Job;
Expand Down
9 changes: 4 additions & 5 deletions kotlinx-coroutines-core/api/kotlinx-coroutines-core.klib.api
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,10 @@ abstract fun interface kotlinx.coroutines/DisposableHandle { // kotlinx.coroutin
abstract fun dispose() // kotlinx.coroutines/DisposableHandle.dispose|dispose(){}[0]
}

abstract fun interface kotlinx.coroutines/Runnable { // kotlinx.coroutines/Runnable|null[0]
abstract fun run() // kotlinx.coroutines/Runnable.run|run(){}[0]
}

abstract interface <#A: in kotlin/Any?> kotlinx.coroutines.channels/ProducerScope : kotlinx.coroutines.channels/SendChannel<#A>, kotlinx.coroutines/CoroutineScope { // kotlinx.coroutines.channels/ProducerScope|null[0]
abstract val channel // kotlinx.coroutines.channels/ProducerScope.channel|{}channel[0]
abstract fun <get-channel>(): kotlinx.coroutines.channels/SendChannel<#A> // kotlinx.coroutines.channels/ProducerScope.channel.<get-channel>|<get-channel>(){}[0]
Expand Down Expand Up @@ -326,10 +330,6 @@ abstract interface kotlinx.coroutines/ParentJob : kotlinx.coroutines/Job { // ko
abstract fun getChildJobCancellationCause(): kotlin.coroutines.cancellation/CancellationException // kotlinx.coroutines/ParentJob.getChildJobCancellationCause|getChildJobCancellationCause(){}[0]
}

abstract interface kotlinx.coroutines/Runnable { // kotlinx.coroutines/Runnable|null[0]
abstract fun run() // kotlinx.coroutines/Runnable.run|run(){}[0]
}

sealed interface <#A: in kotlin/Any?, #B: out kotlin/Any?> kotlinx.coroutines.selects/SelectClause2 : kotlinx.coroutines.selects/SelectClause // kotlinx.coroutines.selects/SelectClause2|null[0]

sealed interface <#A: in kotlin/Any?> kotlinx.coroutines.selects/SelectBuilder { // kotlinx.coroutines.selects/SelectBuilder|null[0]
Expand Down Expand Up @@ -963,7 +963,6 @@ final inline fun <#A: reified kotlin/Any?, #B: kotlin/Any?> kotlinx.coroutines.f
final inline fun <#A: reified kotlin/Any?> (kotlinx.coroutines.flow/Flow<*>).kotlinx.coroutines.flow/filterIsInstance(): kotlinx.coroutines.flow/Flow<#A> // kotlinx.coroutines.flow/filterIsInstance|[email protected]<*>(){0§<kotlin.Any?>}[0]
final inline fun kotlinx.coroutines.flow.internal/checkIndexOverflow(kotlin/Int): kotlin/Int // kotlinx.coroutines.flow.internal/checkIndexOverflow|checkIndexOverflow(kotlin.Int){}[0]
final inline fun kotlinx.coroutines/CoroutineExceptionHandler(crossinline kotlin/Function2<kotlin.coroutines/CoroutineContext, kotlin/Throwable, kotlin/Unit>): kotlinx.coroutines/CoroutineExceptionHandler // kotlinx.coroutines/CoroutineExceptionHandler|CoroutineExceptionHandler(kotlin.Function2<kotlin.coroutines.CoroutineContext,kotlin.Throwable,kotlin.Unit>){}[0]
final inline fun kotlinx.coroutines/Runnable(crossinline kotlin/Function0<kotlin/Unit>): kotlinx.coroutines/Runnable // kotlinx.coroutines/Runnable|Runnable(kotlin.Function0<kotlin.Unit>){}[0]
final suspend fun (kotlin.collections/Collection<kotlinx.coroutines/Job>).kotlinx.coroutines/joinAll() // kotlinx.coroutines/joinAll|[email protected]<kotlinx.coroutines.Job>(){}[0]
final suspend fun (kotlinx.coroutines.channels/ProducerScope<*>).kotlinx.coroutines.channels/awaitClose(kotlin/Function0<kotlin/Unit> = ...) // kotlinx.coroutines.channels/awaitClose|[email protected]<*>(kotlin.Function0<kotlin.Unit>){}[0]
final suspend fun (kotlinx.coroutines.flow/Flow<*>).kotlinx.coroutines.flow/collect() // kotlinx.coroutines.flow/collect|[email protected]<*>(){}[0]
Expand Down
11 changes: 4 additions & 7 deletions kotlinx-coroutines-core/common/src/Runnable.common.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,13 @@ package kotlinx.coroutines

/**
* A runnable task for [CoroutineDispatcher.dispatch].
*
* It is equivalent to the type `() -> Unit`, but on the JVM, it is represented as a `java.lang.Runnable`,
* making it easier to wrap the interfaces that expect `java.lang.Runnable` into a [CoroutineDispatcher].
*/
public expect interface Runnable {
public expect fun interface Runnable {
/**
* @suppress
*/
public fun run()
}

/**
* Creates [Runnable] task instance.
*/
@Suppress("FunctionName")
public expect inline fun Runnable(crossinline block: () -> Unit): Runnable
15 changes: 3 additions & 12 deletions kotlinx-coroutines-core/jsAndWasmShared/src/Runnable.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,12 @@ package kotlinx.coroutines

/**
* A runnable task for [CoroutineDispatcher.dispatch].
*
* Equivalent to the type `() -> Unit`.
*/
public actual interface Runnable {
public actual fun interface Runnable {
/**
* @suppress
*/
public actual fun run()
}

/**
* Creates [Runnable] task instance.
*/
@Suppress("FunctionName")
public actual inline fun Runnable(crossinline block: () -> Unit): Runnable =
object : Runnable {
override fun run() {
block()
}
}
11 changes: 4 additions & 7 deletions kotlinx-coroutines-core/jvm/src/Runnable.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,9 @@ package kotlinx.coroutines

/**
* A runnable task for [CoroutineDispatcher.dispatch].
*
* It is a typealias for [java.lang.Runnable], which is widely used in Java APIs.
* This makes it possible to directly pass the argument of [CoroutineDispatcher.dispatch]
* to the underlying Java implementation without any additional wrapping.
*/
public actual typealias Runnable = java.lang.Runnable

/**
* Creates [Runnable] task instance.
*/
@Suppress("FunctionName")
public actual inline fun Runnable(crossinline block: () -> Unit): Runnable =
java.lang.Runnable { block() }
15 changes: 3 additions & 12 deletions kotlinx-coroutines-core/native/src/Runnable.kt
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,12 @@ package kotlinx.coroutines

/**
* A runnable task for [CoroutineDispatcher.dispatch].
*
* Equivalent to the type `() -> Unit`.
*/
public actual interface Runnable {
public actual fun interface Runnable {
/**
* @suppress
*/
public actual fun run()
}

/**
* Creates [Runnable] task instance.
*/
@Suppress("FunctionName")
public actual inline fun Runnable(crossinline block: () -> Unit): Runnable =
object : Runnable {
override fun run() {
block()
}
}