Right

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

Constructors

Right

fun <out B> Right(value: B)

Types

Companion

object Companion

Functions

all

inline fun all(predicate: (B) -> Boolean): Boolean

bicrosswalk

inline fun <C, D> bicrosswalk(fa: (Nothing) -> Iterable<C>, fb: (B) -> Iterable<D>): List<Ior<C, D>>

bicrosswalkMap

inline fun <C, D, K> bicrosswalkMap(fa: (Nothing) -> Map<K, C>, fb: (B) -> Map<K, D>): Map<K, Ior<C, D>>

bicrosswalkNull

inline fun <C, D> bicrosswalkNull(fa: (Nothing) -> C?, fb: (B) -> D?): Ior<C, D>?

bifoldLeft

inline fun <C> bifoldLeft( c: C, f: (C, Nothing) -> C, g: (C, B) -> C): C

bifoldMap

inline fun <C> bifoldMap( MN: Monoid<C>, f: (Nothing) -> C, g: (B) -> C): C

bimap

inline fun <C, D> bimap(fa: (Nothing) -> C, fb: (B) -> D): Ior<C, D>

Apply fa if this is a Left or Both to A and apply fb if this is Right or Both to B

bitraverse

inline fun <AA, C> bitraverse(fa: (Nothing) -> Iterable<AA>, fb: (B) -> Iterable<C>): List<Ior<AA, C>>

bitraverseEither

inline fun <AA, C, D> bitraverseEither(fa: (Nothing) -> Either<AA, C>, fb: (B) -> Either<AA, D>): Either<AA, Ior<C, D>>

bitraverseNullable

inline fun <C, D> bitraverseNullable(fa: (Nothing) -> C?, fb: (B) -> D?): Ior<C, D>?

bitraverseOption

inline fun <C, D> bitraverseOption(fa: (Nothing) -> Option<C>, fb: (B) -> Option<D>): Option<Ior<C, D>>

bitraverseValidated

inline fun <AA, C, D> bitraverseValidated( SA: Semigroup<AA>, fa: (Nothing) -> Validated<AA, C>, fb: (B) -> Validated<AA, D>): Validated<AA, Ior<C, D>>

crosswalk

inline fun <C> crosswalk(fa: (B) -> Iterable<C>): List<Ior<Nothing, C>>

crosswalkMap

inline fun <K, V> crosswalkMap(fa: (B) -> Map<K, V>): Map<K, Ior<Nothing, V>>

crosswalkNull

inline fun <A, B, C> crosswalkNull(ior: Ior<A, B>, fa: (B) -> C?): Ior<A, C>?

exists

inline fun exists(predicate: (B) -> Boolean): Boolean

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

findOrNull

inline fun findOrNull(predicate: (B) -> Boolean): B?

fold

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

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

foldLeft

inline fun <C> foldLeft(c: C, f: (C, B) -> C): C

foldMap

inline fun <C> foldMap(MN: Monoid<C>, f: (B) -> C): C

isEmpty

fun isEmpty(): Boolean

isNotEmpty

fun isNotEmpty(): Boolean

leftOrNull

fun leftOrNull(): Nothing?

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<Nothing, D>

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

mapLeft

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

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

orNull

fun orNull(): B?

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

padNull

fun padNull(): Pair<Nothing?, B?>

Return this Ior as Pair of nullables]

swap

fun swap(): Ior<B, Nothing>

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<Nothing, 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.

toString

open override fun toString(): String

toValidated

fun toValidated(): Validated<Nothing, B>

Returns a Validated.Valid containing the Right value or B if this is Right or Both and Validated.Invalid if this is a Left.

traverse

inline fun <AA, C> traverse(fa: (B) -> Either<AA, C>): Either<AA, Ior<Nothing, C>>

inline fun <C> traverse(fa: (B) -> Option<C>): Option<Ior<Nothing, C>>

inline fun <AA, C> traverse(fa: (B) -> Validated<AA, C>): Validated<AA, Ior<Nothing, C>>

inline fun <C> traverse(fa: (B) -> Iterable<C>): List<Ior<Nothing, C>>

traverseEither

~~inline~~ ~~fun~~ <AA, C> ~~traverseEither~~(fa: (B) -> Either<AA, C>): Either<AA, Ior<Nothing, C>>

traverseNullable

inline fun <C> traverseNullable(fa: (B) -> C?): Ior<Nothing, C>?

traverseOption

~~inline~~ ~~fun~~ <C> ~~traverseOption~~(fa: (B) -> Option<C>): Option<Ior<Nothing, C>>

traverseValidated

~~inline~~ ~~fun~~ <AA, C> ~~traverseValidated~~(fa: (B) -> Validated<AA, C>): Validated<AA, Ior<Nothing, C>>

unwrap

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

Return the isomorphic Either of this Ior

void

fun void(): Ior<Nothing, Unit>

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: B