Skip to content

Elm

Jump to bottom
Michael Bull edited this page Oct 22, 2017 · 15 revisions

Mappings from Elm's Result type to kotlin-result.

Result.map

<V, E, U> Result<V, E>.map(transform: (V) -> U): Result<U, E>

Apply a function to a Result. If the result is Ok, it will be converted. If the result is an Error, the same error value will propagate through.

val value = Ok(10).map { it + 20 }.get()
// value = 30

Result.andThen

<V, E, U> Result<V, E>.andThen(transform: (V) -> Result<U, E>): Result<U, E>

Chain together a sequence of computations that may fail.

val value = Ok(20).andThen { Ok(it + 30) }.andThen { Ok(it + 40) }.get()
// value = 90

Result.withDefault

<V, E> Result<V, E>.getOr(default: V): V

If the result is Ok return the value, but if the result is an Error then return a given default value.

val value = Err("error").getOr("default")
// value = default

Result.toMaybe

<V, E> Result<V, E>.get(): V?

If the result is Ok return the value, but if the result is an Error then return null.

val value = Ok(230).get()
val error = Err("example").get()
// value = 230
// error = null

Result.mapError

<V, E, F> Result<V, E>.mapError(transform: (E) -> F): Result<V, F>

Transform an Err value.

val error = Ok(55).andThen { Err(100) }.mapError { Err(500) }.getError()
// error = 500

Result.Extra.isOk

Check whether the result is Ok without unwrapping it.

val result = Ok(500)
if (result is Ok) {
    println("Result is ok")
}

Result.Extra.isErr

Check whether the result is Error without unwrapping it.

val result = Err(500)
if (result is Error) {
    println("Result is not ok")
}

Result.Extra.extract

<V, E> Result<V, E>.getOrElse(transform: (E) -> V): V

Turn a Result<V, E> to a V, by applying the conversion function specified to the E.

val value = Err("hello").getOrElse { "world" }
// value = "world"

Result.Extra.mapBoth

<V, E, U> Result<V, E>.mapBoth(success: (V) -> U, failure: (E) -> U): U

Convert a Result<V, E> to a U by applying either a function if the Result is an Error or a function if the Result is Ok. Both of these functions must return the same type.

val value: String = Ok("he").mapBoth(
    success = { "$it succeeded" },
    failure = { "$it failed" }
)
// value = "he succeeded"

Result.Extra.withDefault

<V, E> Result<V, E>.getOr(default: V): V

Returns a Result's value if the Result is an Ok, or the given default value if the Result is an Error.

val value: String = Err("error").getOr("default")
// value = "default"

Result.Extra.combine

<V, E> Iterable<Result<V, E>>.combine(): Result<List<V>, E>

Combine an Iterable of Results into a single Result (holding a List).

val values = combine(
    Ok(20),
    Ok(40),
    Ok(60)
).get()
// values = [ 20, 40, 60 ]

Clone this wiki locally