kresult-core/io.kresult.core/KResult/Success

Success

class Success<out T>(val value: T) : KResult<Nothing, T>

Represents a successful KResult

Empty Success

An empty success, e.g. an action that can fail or be successful but doesn't return any value, can be represented using:

import io.kresult.core.KResult
import io.kotest.matchers.shouldBe

fun test() {
  val res: KResult<Nothing, Unit> =
    KResult.Success.unit

  res.isSuccess() shouldBe true
}

Constructors

Success

constructor(value: T)

Types

Companion

object Companion

Properties

value

val value: T

Functions

combine

fun <E, T> KResult<E, T>.combine(other: KResult<E, T>, combineFailure: (E, E) -> E, combineSuccess: (T, T) -> T): KResult<E, T>

compareTo

operator fun <E : Comparable<E>, T : Comparable<T>> KResult<E, T>.compareTo(other: KResult<E, T>): Int

component1

open operator fun component1(): Nothing?

Failure component for destructuring declaration

component2

open operator fun component2(): T?

Success component for destructuring declaration

equals

open operator override fun equals(other: Any?): Boolean

failureOrNull

fun failureOrNull(): Nothing?

Runs the Failure.error, if the KResult is a failure or null otherwise

filter

inline fun <E, T> KResult<E, T>.filter(f: (success: T) -> Boolean, failureFn: (success: T) -> E): KResult<E, T>

flatMap

inline fun <E, T, T1> KResult<E, T>.flatMap(f: (success: T) -> KResult<E, T1>): KResult<E, T1>

flatMapFailure

fun <E, T, E1> KResult<E, T>.flatMapFailure(f: (failure: E) -> KResult<E1, T>): KResult<E1, T>

flatten

fun <E, T> KResult<E, KResult<E, T>>.flatten(): KResult<E, T>

flattenFailure

fun <E, T> KResult<KResult<E, T>, T>.flattenFailure(): KResult<E, T>

fold

inline fun <R> fold(ifFailure: (failure: Nothing) -> R, ifSuccess: (success: T) -> R): R

Transforms a KResult into a value of R.

getOrElse

infix inline fun <E, T> KResult<E, T>.getOrElse(default: (E) -> T): T

getOrNull

fun getOrNull(): T?

Runs the Success.value, if the KResult is a success or null otherwise

getOrThrow

fun <E : Throwable, T> KResult<E, T>.getOrThrow(): T

If a KResult has a Throwable on failure side, this either returns the Success.value or throws the Failure.error

hashCode

open override fun hashCode(): Int

isFailure

fun isFailure(): Boolean

Indicates if a KResult is a Failure

isSuccess

fun isSuccess(): Boolean

Indicates if a KResult is a Success

map

inline fun <R> map(f: (success: T) -> R): KResult<Nothing, R>

Maps (transforms) the success value T to a new value R

mapFailure

inline fun <R> mapFailure(f: (Nothing) -> R): KResult<R, T>

Maps (transforms) the failure value E to a new value R

merge

fun <T> KResult<T, T>.merge(): T

onFailure

inline fun onFailure(action: (failure: Nothing) -> Unit): KResult<Nothing, T>

Runs an action (side-effect) when the KResult is a Failure

onSuccess

inline fun onSuccess(action: (success: T) -> Unit): KResult<Nothing, T>

Runs an action (side-effect) when the KResult is a Success

swap

fun swap(): KResult<T, Nothing>

Swap the parameters (T and E) of this Result.

toString

open override fun toString(): String