arrow-core-data / arrow.core

Package arrow.core

Types

Continuation interface Continuation<in T> : Continuation<T>
Convenience interface to bridge to old coroutine API and not deal with Result
Either sealed class Either<out A, out B> : EitherOf<A, B>
Port of https://github.com/scala/scala/blob/v2.12.1/src/library/scala/util/Either.scala
Eval sealed class Eval<out A> : EvalOf<A>
Eval is a monad which controls evaluation of a value or a computation that produces a value.
ForEither class ForEither
ForEval class ForEval
ForFunction0 class ForFunction0
ForFunction1 class ForFunction1
ForId class ForId
ForOption class ForOption
ForTry class ForTry
ForTuple10 class ForTuple10
ForTuple11 class ForTuple11
ForTuple12 class ForTuple12
ForTuple13 class ForTuple13
ForTuple14 class ForTuple14
ForTuple15 class ForTuple15
ForTuple16 class ForTuple16
ForTuple17 class ForTuple17
ForTuple18 class ForTuple18
ForTuple19 class ForTuple19
ForTuple2 class ForTuple2
ForTuple20 class ForTuple20
ForTuple21 class ForTuple21
ForTuple22 class ForTuple22
ForTuple3 class ForTuple3
ForTuple4 class ForTuple4
ForTuple5 class ForTuple5
ForTuple6 class ForTuple6
ForTuple7 class ForTuple7
ForTuple8 class ForTuple8
ForTuple9 class ForTuple9
Function0 data class Function0<out A> : Function0Of<A>
Function1 class Function1<I, out O> : Function1Of<I, O>
FunctionK interface FunctionK<F, G>
Id data class Id<out A> : IdOf<A>
ListExtensions object ListExtensions
MapInstances object MapInstances
NonFatal object NonFatal
Extractor of non-fatal Throwables. Will not match fatal errors like VirtualMachineError (for example, OutOfMemoryError and StackOverflowError, subclasses of VirtualMachineError), ThreadDeath, LinkageError, InterruptedException.
None object None : Option<Nothing>
Option sealed class Option<out A> : OptionOf<A>
Represents optional values. Instances of Option are either an instance of $some or the object $none.
PartialFunction abstract class PartialFunction<in A, out B> : (A) -> B
SetExtensions object SetExtensions
Some data class Some<out T> : Option<T>
SortedMapInstances object SortedMapInstances
SortedSetInstances object SortedSetInstances
Try sealed class Try<out A> : TryOf<A>
The Try type represents a computation that may either result in an exception, or return a successfully computed value.
Tuple10 data class Tuple10<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J> : Tuple10Of<A, B, C, D, E, F, G, H, I, J>
Tuple11 data class Tuple11<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K> : Tuple11Of<A, B, C, D, E, F, G, H, I, J, K>
Tuple12 data class Tuple12<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L> : Tuple12Of<A, B, C, D, E, F, G, H, I, J, K, L>
Tuple13 data class Tuple13<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M> : Tuple13Of<A, B, C, D, E, F, G, H, I, J, K, L, M>
Tuple14 data class Tuple14<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N> : Tuple14Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N>
Tuple15 data class Tuple15<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O> : Tuple15Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>
Tuple16 data class Tuple16<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P> : Tuple16Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>
Tuple17 data class Tuple17<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q> : Tuple17Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>
Tuple18 data class Tuple18<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q, out R> : Tuple18Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>
Tuple19 data class Tuple19<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q, out R, out S> : Tuple19Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>
Tuple2 data class Tuple2<out A, out B> : Tuple2Of<A, B>
Tuple20 data class Tuple20<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q, out R, out S, out T> : Tuple20Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>
Tuple21 data class Tuple21<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q, out R, out S, out T, out U> : Tuple21Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U>
Tuple22 data class Tuple22<out A, out B, out C, out D, out E, out F, out G, out H, out I, out J, out K, out L, out M, out N, out O, out P, out Q, out R, out S, out T, out U, out V> : Tuple22Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V>
Tuple3 data class Tuple3<out A, out B, out C> : Tuple3Of<A, B, C>
Tuple4 data class Tuple4<out A, out B, out C, out D> : Tuple4Of<A, B, C, D>
Tuple5 data class Tuple5<out A, out B, out C, out D, out E> : Tuple5Of<A, B, C, D, E>
Tuple6 data class Tuple6<out A, out B, out C, out D, out E, out F> : Tuple6Of<A, B, C, D, E, F>
Tuple7 data class Tuple7<out A, out B, out C, out D, out E, out F, out G> : Tuple7Of<A, B, C, D, E, F, G>
Tuple8 data class Tuple8<out A, out B, out C, out D, out E, out F, out G, out H> : Tuple8Of<A, B, C, D, E, F, G, H>
Tuple9 data class Tuple9<out A, out B, out C, out D, out E, out F, out G, out H, out I> : Tuple9Of<A, B, C, D, E, F, G, H, I>

Exceptions

TryException sealed class TryException : Exception

Type Aliases

EitherOf typealias EitherOf<A, B> = Kind2<ForEither, A, B>
EitherPartialOf typealias EitherPartialOf<A> = Kind<ForEither, A>
EvalOf typealias EvalOf<A> = Kind<ForEval, A>
Failure typealias Failure = Failure
Function0Of typealias Function0Of<A> = Kind<ForFunction0, A>
Function1Of typealias Function1Of<I, O> = Kind2<ForFunction1, I, O>
Function1PartialOf typealias Function1PartialOf<I> = Kind<ForFunction1, I>
IdOf typealias IdOf<A> = Kind<ForId, A>
OptionOf typealias OptionOf<A> = Kind<ForOption, A>
Predicate typealias Predicate<T> = (T) -> Boolean
Success typealias Success<A> = Success<A>
TryOf typealias TryOf<A> = Kind<ForTry, A>
Tuple10Of typealias Tuple10Of<A, B, C, D, E, F, G, H, I, J> = Kind10<ForTuple10, A, B, C, D, E, F, G, H, I, J>
Tuple10PartialOf typealias Tuple10PartialOf<A, B, C, D, E, F, G, H, I> = Kind9<ForTuple10, A, B, C, D, E, F, G, H, I>
Tuple11Of typealias Tuple11Of<A, B, C, D, E, F, G, H, I, J, K> = Kind11<ForTuple11, A, B, C, D, E, F, G, H, I, J, K>
Tuple11PartialOf typealias Tuple11PartialOf<A, B, C, D, E, F, G, H, I, J> = Kind10<ForTuple11, A, B, C, D, E, F, G, H, I, J>
Tuple12Of typealias Tuple12Of<A, B, C, D, E, F, G, H, I, J, K, L> = Kind12<ForTuple12, A, B, C, D, E, F, G, H, I, J, K, L>
Tuple12PartialOf typealias Tuple12PartialOf<A, B, C, D, E, F, G, H, I, J, K> = Kind11<ForTuple12, A, B, C, D, E, F, G, H, I, J, K>
Tuple13Of typealias Tuple13Of<A, B, C, D, E, F, G, H, I, J, K, L, M> = Kind13<ForTuple13, A, B, C, D, E, F, G, H, I, J, K, L, M>
Tuple13PartialOf typealias Tuple13PartialOf<A, B, C, D, E, F, G, H, I, J, K, L> = Kind12<ForTuple13, A, B, C, D, E, F, G, H, I, J, K, L>
Tuple14Of typealias Tuple14Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N> = Kind14<ForTuple14, A, B, C, D, E, F, G, H, I, J, K, L, M, N>
Tuple14PartialOf typealias Tuple14PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M> = Kind13<ForTuple14, A, B, C, D, E, F, G, H, I, J, K, L, M>
Tuple15Of typealias Tuple15Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O> = Kind15<ForTuple15, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>
Tuple15PartialOf typealias Tuple15PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N> = Kind14<ForTuple15, A, B, C, D, E, F, G, H, I, J, K, L, M, N>
Tuple16Of typealias Tuple16Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P> = Kind16<ForTuple16, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>
Tuple16PartialOf typealias Tuple16PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O> = Kind15<ForTuple16, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>
Tuple17Of typealias Tuple17Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q> = Kind17<ForTuple17, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>
Tuple17PartialOf typealias Tuple17PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P> = Kind16<ForTuple17, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>
Tuple18Of typealias Tuple18Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R> = Kind18<ForTuple18, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>
Tuple18PartialOf typealias Tuple18PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q> = Kind17<ForTuple18, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>
Tuple19Of typealias Tuple19Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S> = Kind19<ForTuple19, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>
Tuple19PartialOf typealias Tuple19PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R> = Kind18<ForTuple19, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>
Tuple20Of typealias Tuple20Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T> = Kind20<ForTuple20, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>
Tuple20PartialOf typealias Tuple20PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S> = Kind19<ForTuple20, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>
Tuple21Of typealias Tuple21Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U> = Kind21<ForTuple21, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U>
Tuple21PartialOf typealias Tuple21PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T> = Kind20<ForTuple21, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>
Tuple22Of typealias Tuple22Of<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V> = Kind22<ForTuple22, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V>
Tuple22PartialOf typealias Tuple22PartialOf<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U> = Kind21<ForTuple22, A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U>
Tuple2Of typealias Tuple2Of<A, B> = Kind2<ForTuple2, A, B>
Tuple2PartialOf typealias Tuple2PartialOf<A> = Kind<ForTuple2, A>
Tuple3Of typealias Tuple3Of<A, B, C> = Kind3<ForTuple3, A, B, C>
Tuple3PartialOf typealias Tuple3PartialOf<A, B> = Kind2<ForTuple3, A, B>
Tuple4Of typealias Tuple4Of<A, B, C, D> = Kind4<ForTuple4, A, B, C, D>
Tuple4PartialOf typealias Tuple4PartialOf<A, B, C> = Kind3<ForTuple4, A, B, C>
Tuple5Of typealias Tuple5Of<A, B, C, D, E> = Kind5<ForTuple5, A, B, C, D, E>
Tuple5PartialOf typealias Tuple5PartialOf<A, B, C, D> = Kind4<ForTuple5, A, B, C, D>
Tuple6Of typealias Tuple6Of<A, B, C, D, E, F> = Kind6<ForTuple6, A, B, C, D, E, F>
Tuple6PartialOf typealias Tuple6PartialOf<A, B, C, D, E> = Kind5<ForTuple6, A, B, C, D, E>
Tuple7Of typealias Tuple7Of<A, B, C, D, E, F, G> = Kind7<ForTuple7, A, B, C, D, E, F, G>
Tuple7PartialOf typealias Tuple7PartialOf<A, B, C, D, E, F> = Kind6<ForTuple7, A, B, C, D, E, F>
Tuple8Of typealias Tuple8Of<A, B, C, D, E, F, G, H> = Kind8<ForTuple8, A, B, C, D, E, F, G, H>
Tuple8PartialOf typealias Tuple8PartialOf<A, B, C, D, E, F, G> = Kind7<ForTuple8, A, B, C, D, E, F, G>
Tuple9Of typealias Tuple9Of<A, B, C, D, E, F, G, H, I> = Kind9<ForTuple9, A, B, C, D, E, F, G, H, I>
Tuple9PartialOf typealias Tuple9PartialOf<A, B, C, D, E, F, G, H> = Kind8<ForTuple9, A, B, C, D, E, F, G, H>

Extensions for External Classes

arrow.Kind  
kotlin.Array  
kotlin.Boolean  
kotlin.Function0  
kotlin.Function1  
kotlin.Function2  
kotlin.Pair  
kotlin.Throwable  
kotlin.collections.Iterable  
kotlin.collections.Map  
kotlin.collections.Map.Entry  
kotlin.sequences.Sequence  

Properties

DeprecatedAmbiguity const val DeprecatedAmbiguity: String
DeprecatedUnsafeAccess const val DeprecatedUnsafeAccess: String

Functions

Left fun <L> Left(left: L): Either<L, Nothing>
PartialFunction fun <A, B> PartialFunction(definedAt: (A) -> Boolean, ifDefined: (A) -> B): PartialFunction<A, B>
Right fun <R> Right(right: R): Either<Nothing, R>
andThen fun <A, B, C> PartialFunction<A, B>.andThen(f: (B) -> C): PartialFunction<A, C>
case fun <A, B> case(ff: Tuple2<(A) -> Boolean, (A) -> B>): PartialFunction<A, B>
constant fun <P1, T> constant(t: T): (P1) -> T
getOrElse fun <T> Option<T>.getOrElse(default: () -> T): T
Returns the option’s value if the option is nonempty, otherwise return the result of evaluating default.
identity fun <A> identity(a: A): A
invokeOrElse fun <A, B : B1, A1 : A, B1> PartialFunction<A, B>.invokeOrElse(x: A1, default: (A1) -> B1): B1
Applies this partial function to the given argument when it is contained in the function domain. Applies fallback function where this partial function is not defined.fun <P1, R> PartialFunction<P1, R>.invokeOrElse(p1: P1, default: R): R
left fun <A> A.left(): Either<A, Nothing>
lift fun <A, B> PartialFunction<A, B>.lift(): (A) -> Option<B>
Turns this partial function into a plain function returning an Option result.
mapOf fun <K, V> mapOf(vararg tuples: Tuple2<K, V>): Map<K, V>
fun <K, V> mapOf(pair: Tuple2<K, V>): Map<K, V>
none fun <A> none(): Option<A>
orElse infix fun <A, B> PartialFunction<A, B>.orElse(f: PartialFunction<A, B>): PartialFunction<A, B>
right fun <A> A.right(): Either<Nothing, A>
rightIfNotNull fun <A, B> B?.rightIfNotNull(default: () -> A): Either<A, B>
Returns Either.Right if the value of type B is not null, otherwise the specified A value wrapped into an Either.Left.
select fun <A, B> (() -> Either<A, B>).select(f: Function0Of<(A) -> B>): () -> B
fun <A, B> Id<Either<A, B>>.select(f: IdOf<(A) -> B>): Id<B>
fun <A, B> Option<Either<A, B>>.select(f: OptionOf<(A) -> B>): Option<B>
some fun <A> A.some(): Option<A>
success fun <A> A.success(): Try<A>
toOption fun <T> T?.toOption(): Option<T>
toPair fun <K, V> Tuple2<K, V>.toPair(): Pair<K, V>
toT infix fun <A, B> A.toT(b: B): Tuple2<A, B>