Add Rust reference comments for on{Success,Failure}

michaelbull · Mar 2, 2024 · 73a7115 · 73a7115
1 parent 05d50b7
commit 73a7115
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/On.kt b/kotlin-result/src/commonMain/kotlin/com/github/michaelbull/result/On.kt
@@ -5,6 +5,8 @@ import kotlin.contracts.contract
 
 /**
  * Invokes an [action] if this [Result] is [Ok].
+ *
+ * - Rust: [Result.inspect](https://doc.rust-lang.org/std/result/enum.Result.html#method.inspect)
  */
 public inline infix fun <V, E> Result<V, E>.onSuccess(action: (V) -> Unit): Result<V, E> {
     contract {
@@ -20,6 +22,8 @@ public inline infix fun <V, E> Result<V, E>.onSuccess(action: (V) -> Unit): Resu
 
 /**
  * Invokes an [action] if this [Result] is [Err].
+ *
+ * - Rust [Result.inspect_err](https://doc.rust-lang.org/std/result/enum.Result.html#method.inspect_err)
  */
 public inline infix fun <V, E> Result<V, E>.onFailure(action: (E) -> Unit): Result<V, E> {
     contract {