arrow-fx / arrow.fx

Package arrow.fx

Types

ConnectionCancellationException object ~~ConnectionCancellationException~~ : JavaCancellationException
DecisionOf typealias ~~DecisionOf~~<A, B> = Kind2<ForDecision, A, B>
DecisionPartialOf typealias ~~DecisionPartialOf~~<A> = Kind<ForDecision, A>
Dequeue Dequeue allows peeking and taking values from a Queue, but doesn’t allow offering values to the Queue. You can use Dequeue to restrict certain functions or layers of your applications to only consume values.interface ~~Dequeue~~<F, A>
Enqueue Enqueue allows offering values to a Queue, but doesn’t allow taking values from the Queue. You can use Enqueue to restrict certain functions or layers of your applications to only produce values.interface ~~Enqueue~~<F, A>
ForDecision class ~~ForDecision~~
ForIO class ~~ForIO~~
ForQueue class ~~ForQueue~~
ForResource class ~~ForResource~~
ForSchedule class ~~ForSchedule~~
IO sealed class ~~IO~~<out A> : IOOf<A>
IODispatchers object ~~IODispatchers~~
IOOf typealias ~~IOOf~~<A> = Kind<ForIO, A>
IOParMap Mix-in to enable parMapN N-arity on IO’s companion directly.interface ~~IOParMap~~
IOProc typealias ~~IOProc~~<A> = ((Either<Throwable, A>) -> Unit) -> Unit
IOProcF typealias ~~IOProcF~~<A> = ((Either<Throwable, A>) -> Unit) -> IOOf<Unit>
IORace interface ~~IORace~~
MVar It’s a mutable variable with context F, that is either empty or contains a value of type A. A pure concurrent queue of size 1.interface ~~MVar~~<F, A>
MVarFactory Builds a MVar value for data types F without deciding the type of the MVar’s value.interface MVarFactory<F>
OnCancel enum class ~~OnCancel~~
Promise When made, a Promise is empty. Until it is fulfilled, which can only happen once.interface ~~Promise~~<F, A>
Queue Lightweight Concurrent Queue for values of A.interface ~~Queue~~<F, A> : QueueOf<F, A>, Dequeue<F, A>, Enqueue<F, A>
QueueFactory Builds a QueueFactory for data type F without fixing the Queue’s A type or the Queue.BackpressureStrategy.interface ~~QueueFactory~~<F>
QueueOf typealias ~~QueueOf~~<F, A> = Kind2<ForQueue, F, A>
QueuePartialOf typealias ~~QueuePartialOf~~<F> = Kind<ForQueue, F>
Race2 Alias for Either structure to provide consistent signature for race methods.typealias ~~Race2~~<A, B> = Either<A, B>
Race3 sealed class ~~Race3~~<out A, out B, out C>
Race4 sealed class ~~Race4~~<out A, out B, out C, out D>
Race5 sealed class ~~Race5~~<out A, out B, out C, out D, out E>
Race6 sealed class ~~Race6~~<out A, out B, out C, out D, out E, out F>
Race7 sealed class ~~Race7~~<out A, out B, out C, out D, out E, out F, out G>
Race8 sealed class ~~Race8~~<out A, out B, out C, out D, out E, out F, out G, out H>
Race9 sealed class ~~Race9~~<out A, out B, out C, out D, out E, out F, out G, out H, out I>
RacePair Alias for Either structure to provide consistent signature for race methods.sealed class ~~RacePair~~<F, A, B>
RaceTriple sealed class ~~RaceTriple~~<F, A, B, C>
Ref An asynchronous, concurrent mutable reference.interface ~~Ref~~<F, A>
RefFactory Builds a Ref value for data types F without deciding the type of the Ref’s value.interface ~~RefFactory~~<F>
Resource Resource models resource allocation and releasing. It is especially useful when multiple resources that depend on each other need to be acquired and later released in reverse order. When a resource is created one can make use of use to run a computation with the resource. The finalizers are then guaranteed to run afterwards in reverse order of acquisition.sealed class ~~Resource~~<F, E, A> : ResourceOf<F, E, A>
ResourceKindedJ typealias ~~ResourceKindedJ~~<F, E, A> = HkJ3<ForResource, F, E, A>
ResourceOf typealias ~~ResourceOf~~<F, E, A> = Kind3<ForResource, F, E, A>
ResourcePartialOf typealias ~~ResourcePartialOf~~<F, E> = Kind2<ForResource, F, E>
Schedule Retrying and repeating effectssealed class ~~Schedule~~<F, Input, Output> : ScheduleOf<F, Input, Output>
ScheduleKindedJ typealias ~~ScheduleKindedJ~~<M, Input, Output> = HkJ3<ForSchedule, M, Input, Output>
ScheduleOf typealias ~~ScheduleOf~~<M, Input, Output> = Kind3<ForSchedule, M, Input, Output>
SchedulePartialOf typealias ~~SchedulePartialOf~~<M, Input> = Kind2<ForSchedule, M, Input>
Semaphore A counting Semaphore is used to control access to a resource in a concurrent system. It keeps track of the count of available resources.interface ~~Semaphore~~<F>
Timer Timer allows to sleep for a Duration in F. This behaviour can be derived from Concurrent, and can be used to implement backing off retries etc.interface ~~Timer~~<F>

Extensions for External Classes

arrow.Kind  
java.util.concurrent.ExecutorService  

Properties

IODeprecation const val IODeprecation: String

Functions

effectMapEither Transform, as a suspend effect, the value of an IO into an Either and consequently flatten into an IOfun <E : Throwable, A, B> IO<A>.effectMapEither(f: suspend (A) -> EitherOf<E, B>): IO<B>
flattenEither Flatten an IO with a success of Either into an IO of A, when the left is the same error (E) as the original IO and the right is A.fun <E : Throwable, A> IO<EitherOf<E, A>>.flattenEither(): IO<A>
mapEither Transform the value of an IO into an Either and consequently flatten into an IOfun <E : Throwable, A, B> IO<A>.mapEither(f: (A) -> EitherOf<E, B>): IO<B>

Do you like Arrow?

Arrow Org
<