Rollback changes in Bracket

arrow-kt · Nov 8, 2023 · dd4960d · dd4960d
1 parent cf4ea7a
commit dd4960d
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 13 deletions.
diff --git a/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Effect.kt b/arrow-libs/core/arrow-core/src/commonMain/kotlin/arrow/core/raise/Effect.kt
@@ -338,7 +338,7 @@ import kotlin.jvm.JvmName
  * -->
  * ```kotlin
  * suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
- *   guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+ *   guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
  *
  * ```
  *
@@ -374,7 +374,7 @@ import kotlin.jvm.JvmName
  * import kotlinx.coroutines.awaitCancellation
  *
  * suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
- *  guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+ *  guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
  *
  * suspend fun <A> CompletableDeferred<A>.getOrNull(): A? =
  *  if (isCompleted) await() else null
@@ -413,7 +413,7 @@ import kotlin.jvm.JvmName
  * import kotlinx.coroutines.awaitCancellation
  *
  * suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
- *   guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+ *   guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
  *
  * suspend fun <A> CompletableDeferred<A>.getOrNull(): A? =
  *   if (isCompleted) await() else null
@@ -552,7 +552,7 @@ import kotlin.jvm.JvmName
  * }
  *
  * suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
- *   guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+ *   guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
  * -->
  * ```kotlin
  * suspend fun main() {

diff --git a/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-05.kt b/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-05.kt
@@ -13,7 +13,7 @@ import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.awaitCancellation
 
 suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
-  guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+  guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
 
  suspend fun main() {
    val error = "Error"

diff --git a/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-06.kt b/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-06.kt
@@ -13,7 +13,7 @@ import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.awaitCancellation
 
 suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
- guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+ guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
 
 suspend fun <A> CompletableDeferred<A>.getOrNull(): A? =
  if (isCompleted) await() else null

diff --git a/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-07.kt b/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-07.kt
@@ -14,7 +14,7 @@ import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.awaitCancellation
 
 suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
-  guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+  guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
 
 suspend fun <A> CompletableDeferred<A>.getOrNull(): A? =
   if (isCompleted) await() else null

diff --git a/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-10.kt b/arrow-libs/core/arrow-core/src/jvmTest/kotlin/examples/example-raise-10.kt
@@ -43,7 +43,7 @@ fun readFile(path: String?): Effect<FileError, Content> = effect {
 }
 
 suspend fun <A> awaitExitCase(exit: CompletableDeferred<ExitCase>): A =
-  guaranteeCase({ awaitCancellation() }) { exitCase -> exit.complete(exitCase) }
+  guaranteeCase(::awaitCancellation) { exitCase -> exit.complete(exitCase) }
 
 suspend fun main() {
   val exit = CompletableDeferred<ExitCase>()

diff --git a/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Bracket.kt b/arrow-libs/fx/arrow-fx-coroutines/src/commonMain/kotlin/arrow/fx/coroutines/Bracket.kt
@@ -31,8 +31,9 @@ public sealed class ExitCase {
  * @see guarantee for registering a handler that is guaranteed to always run.
  * @see guaranteeCase for registering a handler that executes for any [ExitCase].
  */
+@Suppress("REDUNDANT_INLINE_SUSPEND_FUNCTION_TYPE")
 public suspend inline fun <A> onCancel(
-  fa: () -> A,
+  fa: suspend () -> A,
   crossinline onCancel: suspend () -> Unit
 ): A = guaranteeCase(fa) { case ->
   when (case) {
@@ -54,8 +55,9 @@ public suspend inline fun <A> onCancel(
  * @param finalizer handler to run after [fa].
  * @see guaranteeCase for registering a handler that tracks the [ExitCase] of [fa].
  */
+@Suppress("REDUNDANT_INLINE_SUSPEND_FUNCTION_TYPE")
 public suspend inline fun <A> guarantee(
-  fa: () -> A,
+  fa: suspend () -> A,
   crossinline finalizer: suspend () -> Unit
 ): A {
   val res = try {
@@ -83,8 +85,9 @@ public suspend inline fun <A> guarantee(
  * @param finalizer handler to run after [fa].
  * @see guarantee for registering a handler that ignores the [ExitCase] of [fa].
  */
+@Suppress("REDUNDANT_INLINE_SUSPEND_FUNCTION_TYPE")
 public suspend inline fun <A> guaranteeCase(
-  fa: () -> A,
+  fa: suspend () -> A,
   crossinline finalizer: suspend (ExitCase) -> Unit
 ): A {
   val res = try {
@@ -138,9 +141,10 @@ public suspend inline fun <A> guaranteeCase(
  * ```
  * <!--- KNIT example-bracket-01.kt -->
  */
+@Suppress("REDUNDANT_INLINE_SUSPEND_FUNCTION_TYPE")
 public suspend inline fun <A, B> bracket(
   crossinline acquire: suspend () -> A,
-  use: (A) -> B,
+  use: suspend (A) -> B,
   crossinline release: suspend (A) -> Unit
 ): B {
   val acquired = withContext(NonCancellable) {
@@ -221,9 +225,10 @@ public suspend inline fun <A, B> bracket(
  * ```
  * <!--- KNIT example-bracket-02.kt -->
  */
+@Suppress("REDUNDANT_INLINE_SUSPEND_FUNCTION_TYPE")
 public suspend inline fun <A, B> bracketCase(
   crossinline acquire: suspend () -> A,
-  use: (A) -> B,
+  use: suspend (A) -> B,
   crossinline release: suspend (A, ExitCase) -> Unit
 ): B {
   val acquired = withContext(NonCancellable) {