Ior

sealed class Ior<out A, out B>

Port of https://github.com/typelevel/cats/blob/v0.9.0/core/src/main/scala/cats/data/Ior.scala

Represents a right-biased disjunction that is either an A, or a B, or both an A and a B.

An instance of Ior<A,B> is one of:

Ior.Left<A>
Ior.Right<B>
Ior.Both<A,B>

Ior<A,B> is similar to Either<A,B>, except that it can represent the simultaneous presence of an A and a B. It is right-biased so methods such as map and flatMap operate on the B value. Some methods, like flatMap, handle the presence of two Ior.Both values using a combine function (A, A) -> A, while other methods, like toEither, ignore the A value in a Ior.Both Both.

Ior<A,B> is isomorphic to Either<Either<A,B>, Pair<A,B>>, but provides methods biased toward B values, regardless of whether the B values appear in a Ior.Right or a Ior.Both. The isomorphic Either form can be accessed via the unwrap method.

Inheritors

Left

Right

Both

Types

Both

data class Both<out A, out B>(val leftValue: A, val rightValue: B) : Ior<A, B>

Companion

object Companion

Left

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

Right

data class Right<out B>(val value: B) : Ior<Nothing, B>

Functions

combine

inline 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: (B) -> C, fab: (A, B) -> 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(): B?

handleErrorWith

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

Binds the given function across Ior.Left.

isBoth

fun isBoth(): Boolean

Returns true if this is a Both, false otherwise.

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

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

isLeft

fun isLeft(): Boolean

Returns true if this is a Left, false otherwise.

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

fun isRight(): Boolean

Returns true if this is a Right, false otherwise.

inline fun isRight(predicate: (B) -> 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: (B) -> 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, B>

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

swap

fun swap(): Ior<B, 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, B>

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?, B?>

toString

open override fun toString(): String

unwrap

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

Return the isomorphic Either of this Ior