arrow-core/arrow.core/Ior/Left

Left

data class Left<out A>(val value: A) : Ior<A, Nothing> (source)

Constructors

Left

constructor(value: A)

Types

Companion

object Companion

Properties

isBoth

open override val isBoth: Boolean

Returns true if this is a Both, false otherwise.

isLeft

open override val isLeft: Boolean

Returns true if this is a Left, false otherwise.

isRight

open override val isRight: Boolean

Returns true if this is a Right, false otherwise.

value

val value: A

Functions

combine

fun <A, B> Ior<A, B>.combine(other: Ior<A, B>, combineA: (A, A) -> A, combineB: (B, B) -> B): Ior<A, B>

compareTo

operator fun <A : Comparable<A>, B : Comparable<B>> Ior<A, B>.compareTo(other: Ior<A, B>): Int

flatMap

inline fun <A, B, D> Ior<A, B>.flatMap(combine: (A, A) -> A, f: (B) -> Ior<A, D>): Ior<A, D>

Binds the given function across Ior.Right.

flatten

inline fun <A, B> Ior<A, Ior<A, B>>.flatten(combine: (A, A) -> A): Ior<A, B>

fold

inline fun <C> fold(fa: (A) -> C, fb: (Nothing) -> C, fab: (A, Nothing) -> C): C

Applies fa if this is a Left, fb if this is a Right or fab if this is a Both

getOrElse

inline fun <A, B> Ior<A, B>.getOrElse(default: (A) -> B): B

getOrNull

fun getOrNull(): Nothing?

isBoth

@JvmName(name = "_isBoth")

fun isBoth(): Boolean

inline fun isBoth(leftPredicate: (A) -> Boolean, rightPredicate: (Nothing) -> Boolean): Boolean

Returns false if Right or Left, or returns the result of the application of the given predicate to the Both value.

isLeft

@JvmName(name = "_isLeft")

fun isLeft(): Boolean

inline fun isLeft(predicate: (A) -> Boolean): Boolean

Returns false if Right or Both, or returns the result of the application of the given predicate to the Left value.

isRight

@JvmName(name = "_isRight")

fun isRight(): Boolean

inline fun isRight(predicate: (Nothing) -> Boolean): Boolean

Returns false if Left or Both, or returns the result of the application of the given predicate to the Right value.

leftOrNull

fun leftOrNull(): A?

Returns the Left value or A if this is Left or Both and null if this is a Right.

map

inline fun <D> map(f: (Nothing) -> D): Ior<A, D>

The given function is applied if this is a Right or Both to B.

mapLeft

inline fun <C> mapLeft(fa: (A) -> C): Ior<C, Nothing>

The given function is applied if this is a Left or Both to A.

swap

fun swap(): Ior<Nothing, A>

If this is a Left, then return the left value in Right or vice versa, when this is Both , left and right values are swap

toEither

fun toEither(): Either<A, Nothing>

Returns a Either.Right containing the Right value or B if this is Right or Both and Either.Left if this is a Left.

toIorNel

fun <A, B> Ior<A, B>.toIorNel(): IorNel<A, B>

Given an Ior with an error type A, returns an IorNel with the same error type. Wraps the original error in a NonEmptyList so that it can be combined with an IorNel in a Raise DSL which operates on one.

toPair

fun toPair(): Pair<A?, Nothing?>

toString

open override fun toString(): String

unwrap

fun unwrap(): Either<Either<A, Nothing>, Pair<A, Nothing>>

Return the isomorphic Either of this Ior