franklinblanco/kotlin-result
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Replace code blocks in comments with variable references

Browse Source
This commit is contained in:
Michael Bull 2020-01-31 09:21:41 +00:00
parent 43ebd5753a
commit 4ed42cc407
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/main/kotlin/com/github/michaelbull/result/Factory.kt
View File

@ -21,7 +21,7 @@ inline fun <V> runCatching(block: () -> V): Result<V, Throwable> {
} }
/** /**
* Calls the specified function [block] with `this` value as its receiver and * Calls the specified function [block] with [this] value as its receiver and
* returns its encapsulated result if invocation was successful, catching and * returns its encapsulated result if invocation was successful, catching and
* encapsulating any thrown exception as a failure. * encapsulating any thrown exception as a failure.
*/ */

10
src/main/kotlin/com/github/michaelbull/result/Map.kt
View File

@ -62,7 +62,7 @@ inline fun <V, E, U> Result<V, E>.mapOr(default: U, transform: (V) -> U): U {
/** /**
* Maps this [Result<V, E>][Result] to [U] by applying either the [transform] function if this * Maps this [Result<V, E>][Result] to [U] by applying either the [transform] function if this
* [Result] is [Ok], or the [default] function if this [Result] is an [Err]. Both of these * [Result] is [Ok], or the [default] function if this [Result] is an [Err]. Both of these
* functions must return the same type (`U`). * functions must return the same type ([U]).
* *
* - Rust: [Result.map_or_else](https://doc.rust-lang.org/std/result/enum.Result.html#method.map_or_else) * - Rust: [Result.map_or_else](https://doc.rust-lang.org/std/result/enum.Result.html#method.map_or_else)
*/ */
@ -95,9 +95,9 @@ inline infix fun <V, E, U> Result<Iterable<V>, E>.mapAll(transform: (V) -> Resul
} }
/** /**
* Maps this [Result<V, E>][Result] to `U` by applying either the [success] function if this * Maps this [Result<V, E>][Result] to [U] by applying either the [success] function if this
* [Result] is [Ok], or the [failure] function if this [Result] is an [Err]. Both of these * [Result] is [Ok], or the [failure] function if this [Result] is an [Err]. Both of these
* functions must return the same type (`U`). * functions must return the same type ([U]).
* *
* - Elm: [Result.Extra.mapBoth](http://package.elm-lang.org/packages/elm-community/result-extra/2.2.0/Result-Extra#mapBoth) * - Elm: [Result.Extra.mapBoth](http://package.elm-lang.org/packages/elm-community/result-extra/2.2.0/Result-Extra#mapBoth)
* - Haskell: [Data.Either.either](https://hackage.haskell.org/package/base-4.10.0.0/docs/Data-Either.html#v:either) * - Haskell: [Data.Either.either](https://hackage.haskell.org/package/base-4.10.0.0/docs/Data-Either.html#v:either)
@ -115,9 +115,9 @@ inline fun <V, E, U> Result<V, E>.mapBoth(success: (V) -> U, failure: (E) -> U):
} }
/** /**
* Maps this [Result<V, E>][Result] to `U` by applying either the [success] function if this * Maps this [Result<V, E>][Result] to [U] by applying either the [success] function if this
* [Result] is [Ok], or the [failure] function if this [Result] is an [Err]. Both of these * [Result] is [Ok], or the [failure] function if this [Result] is an [Err]. Both of these
* functions must return the same type (`U`). * functions must return the same type ([U]).
* *
* This is functionally equivalent to [mapBoth]. * This is functionally equivalent to [mapBoth].
* *