//arrow-core/arrow.core/Either/Left

Left

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

The left side of the disjoint union, as opposed to the Right side.

Constructors

   
Left common fun <out A> Left(value: A)

Types

Name Summary
Companion common object Companion

Functions

Name Summary
all common inline fun all(predicate: (Nothing) -> Boolean): Boolean
Returns true if Left or returns the result of the application of the given predicate to the Right value.
bifoldLeft common inline fun <C> bifoldLeft(c: C, f: (C, A) -> C, g: (C, Nothing) -> C): C
bifoldMap common inline fun <C> bifoldMap(MN: Monoid<C>, f: (A) -> C, g: (Nothing) -> C): C
bimap common inline fun <C, D> bimap(leftOperation: (A) -> C, rightOperation: (Nothing) -> D): Either<C, D>
Map over Left and Right of this Either
bitraverse common inline fun <AA, C> bitraverse(fe: (A) -> Iterable<AA>, fa: (Nothing) -> Iterable<C>): List<Either<AA, C»
bitraverseNullable common inline fun <AA, C> bitraverseNullable(fl: (A) -> AA?, fr: (Nothing) -> C?): Either<AA, C>?
bitraverseOption common inline fun <AA, C> bitraverseOption(fl: (A) -> Option<AA>, fr: (Nothing) -> Option<C>): Option<Either<AA, C»
bitraverseValidated common inline fun <AA, C, D> bitraverseValidated(fe: (A) -> Validated<AA, C>, fa: (Nothing) -> Validated<AA, D>): Validated<AA, Either<C, D»
exists common inline fun exists(predicate: (Nothing) -> Boolean): Boolean
Returns false if Left or returns the result of the application of the given predicate to the Right value.
findOrNull common inline fun findOrNull(predicate: (Nothing) -> Boolean): Nothing?
fold common inline fun <C> fold(ifLeft: (A) -> C, ifRight: (Nothing) -> C): C
Applies ifLeft if this is a Left or ifRight if this is a Right.
foldLeft common inline fun <C> foldLeft(initial: C, rightOperation: (C, Nothing) -> C): C
foldMap common fun <C> foldMap(MN: Monoid<C>, f: (Nothing) -> C): C
isEmpty common fun isEmpty(): Boolean
Returns true if Left
isLeft common fun isLeft(): Boolean
isNotEmpty common fun isNotEmpty(): Boolean
Returns true if Right
isRight common fun isRight(): Boolean
map common inline fun <C> map(f: (Nothing) -> C): Either<A, C>
The given function is applied if this is a Right.
mapLeft common inline fun <C> mapLeft(f: (A) -> C): Either<C, Nothing>
The given function is applied if this is a Left.
orNone common fun orNone(): Option<Nothing>
orNull common fun orNull(): Nothing?
Returns the right value if it exists, otherwise null
replicate common fun replicate(n: Int): Either<A, List<Nothing»
swap common fun swap(): Either<Nothing, A>
If this is a Left, then return the left value in Right or vice versa.
tap common inline fun tap(f: (Nothing) -> Unit): Either<A, Nothing>
The given function is applied as a fire and forget effect if this is a Right. When applied the result is ignored and the original Either value is returned
tapLeft common inline fun tapLeft(f: (A) -> Unit): Either<A, Nothing>
The given function is applied as a fire and forget effect if this is a Left. When applied the result is ignored and the original Either value is returned
toString common open override fun toString(): String
toValidated common fun toValidated(): Validated<A, Nothing>
toValidatedNel common fun toValidatedNel(): ValidatedNel<A, Nothing>
traverse common inline fun <C> traverse(fa: (Nothing) -> Iterable<C>): List<Either<A, C»
traverseNullable common inline fun <C> traverseNullable(fa: (Nothing) -> C?): Either<A, C>?
traverseOption common inline fun <C> traverseOption(fa: (Nothing) -> Option<C>): Option<Either<A, C»
traverseValidated common inline fun <AA, C> traverseValidated(fa: (Nothing) -> Validated<AA, C>): Validated<AA, Either<A, C»
void common fun void(): Either<A, Unit>

Properties

Name Summary
value common val value: A

Do you like Arrow?

Arrow Org
<