InsanusMokrassar/MicroUtils
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/MicroUtils.git synced 2024-09-07 19:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix of #374

Browse Source
This commit is contained in:
InsanusMokrassar 2024-07-15 08:43:23 +06:00
parent 40f7cf7678
commit 5314833041
3 changed files with 109 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -4,6 +4,10 @@
* `Colors`:
* Added as a module. It should be used by default in case you wish all the API currently realized for `HEXAColor`
* `Coroutines`:
* Fix of [#374](https://github.com/InsanusMokrassar/MicroUtils/issues/374):
* Add vararg variants of `awaitFirst`
* Add `joinFirst`
## 0.21.2

41
coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/AwaitFirst.kt
View File

@ -3,6 +3,12 @@ package dev.inmo.micro_utils.coroutines
import kotlinx.coroutines.*
import kotlin.coroutines.*
/**
* Trying to [Deferred.await] on all [this] [Deferred]s. The first [Deferred] completed its work will interrupt all
* others awaits and, if [cancelOnResult] passed as true (**by default**), will also cancel all the others [Deferred]s
*
* @param scope Will be used to create [CoroutineScope.LinkedSupervisorScope] and launch joining of all [Job]s in it
*/
suspend fun <T> Iterable<Deferred<T>>.awaitFirstWithDeferred(
scope: CoroutineScope,
cancelOnResult: Boolean = true
@ -24,10 +30,45 @@ suspend fun <T> Iterable<Deferred<T>>.awaitFirstWithDeferred(
}
}
/**
* Trying to [Deferred.await] on all [this] [Deferred]s. The first [Deferred] completed its work will interrupt all
* others awaits and, if [cancelOnResult] passed as true (**by default**), will also cancel all the others [Deferred]s
*
* @param scope Will be used to create [CoroutineScope.LinkedSupervisorScope] and launch joining of all [Job]s in it
*/
suspend fun <T> Iterable<Deferred<T>>.awaitFirst(
scope: CoroutineScope,
cancelOnResult: Boolean = true
): T = awaitFirstWithDeferred(scope, cancelOnResult).second
/**
* Trying to [Deferred.await] on all [this] [Deferred]s. The first [Deferred] completed its work will interrupt all
* others awaits and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [Deferred]s
*
* Creates [CoroutineScope] using [coroutineContext] for internal purposes
*/
suspend fun <T> Iterable<Deferred<T>>.awaitFirst(
cancelOthers: Boolean = true
): T = awaitFirst(CoroutineScope(coroutineContext), cancelOthers)
/**
* Trying to [Deferred.await] on all [deferreds]. The first [Deferred] completed its work will interrupt all
* others awaits and, if [cancelOnResult] passed as true (**by default**), will also cancel all the others [deferreds]
*
* @param scope Will be used to create [CoroutineScope.LinkedSupervisorScope] and launch joining of all [Job]s in it
*/
suspend fun <T> awaitFirst(
vararg deferreds: Deferred<T>,
scope: CoroutineScope,
cancelOnResult: Boolean = true
): T = deferreds.toList().awaitFirstWithDeferred(scope, cancelOnResult).second
/**
* Trying to [Deferred.await] on all [deferreds]. The first [Deferred] completed its work will interrupt all
* others awaits and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [deferreds]
*
* Creates [CoroutineScope] using [coroutineContext] for internal purposes
*/
suspend fun <T> awaitFirst(
vararg deferreds: Deferred<T>,
cancelOthers: Boolean = true
): T = awaitFirst(*deferreds, scope = CoroutineScope(coroutineContext), cancelOnResult = cancelOthers)

64
coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/JoinFirst.kt Normal file
View File

@ -0,0 +1,64 @@
package dev.inmo.micro_utils.coroutines
import kotlinx.coroutines.*
import kotlin.coroutines.*
/**
* Trying to [Job.join] on all [this] [Job]s. The first [Job] completed its work will interrupt all others joins
* and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [Job]s
*
* @param scope Will be used to create [CoroutineScope.LinkedSupervisorScope] and launch joining of all [Job]s in it
*/
suspend fun Iterable<Job>.joinFirst(
scope: CoroutineScope,
cancelOthers: Boolean = true
): Job {
val resultDeferred = CompletableDeferred<Job>()
val scope = scope.LinkedSupervisorScope()
forEach {
scope.launch {
it.join()
resultDeferred.complete(it)
scope.cancel()
}
}
return resultDeferred.await().also {
if (cancelOthers) {
forEach {
runCatchingSafely { it.cancel() }
}
}
}
}
/**
* Trying to [Job.join] on all [this] [Job]s. The first [Job] completed its work will interrupt all others joins
* and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [Job]s
*
* Creates [CoroutineScope] using [coroutineContext] for internal purposes
*/
suspend fun Iterable<Job>.joinFirst(
cancelOthers: Boolean = true
): Job = joinFirst(CoroutineScope(coroutineContext), cancelOthers)
/**
* Trying to [Job.join] on all [jobs]. The first [Job] completed its work will interrupt all others joins
* and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [Job]s
*
* @param scope Will be used to create [CoroutineScope.LinkedSupervisorScope] and launch joining of all [Job]s in it
*/
suspend fun joinFirst(
vararg jobs: Job,
scope: CoroutineScope,
cancelOthers: Boolean = true
): Job = jobs.toList().joinFirst(scope, cancelOthers)
/**
* Trying to [Job.join] on all [jobs]. The first [Job] completed its work will interrupt all others joins
* and, if [cancelOthers] passed as true (**by default**), will also cancel all the others [Job]s
*
* Creates [CoroutineScope] using [coroutineContext] for internal purposes
*/
suspend fun joinFirst(
vararg jobs: Job,
cancelOthers: Boolean = true
): Job = joinFirst(*jobs, scope = CoroutineScope(coroutineContext), cancelOthers = cancelOthers)