Package com.github.tonivade.purefun.effect

Class EIO<E,A>

java.lang.Object

com.github.tonivade.purefun.effect.EIO<E,A>

All Implemented Interfaces:

Applicable<EIO<E,?>,A>, Bindable<EIO<E,?>,A>, Effect<EIO<E,?>,A>, Mappable<EIO<E,?>,A>, EIOOf<E,A>, Kind<EIO<E,?>,A>

public final class EIO<E,A>
extends Object
implements EIOOf<E,A>, Effect<EIO<E,?>,A>

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.core.Applicable

Applicable.Map2<F extends Applicable<F,?>,A,B>, Applicable.Map3<F extends Applicable<F,?>,A,B,C>, Applicable.Map4<F extends Applicable<F,?>,A,B,C,D>, Applicable.Map5<F extends Applicable<F,?>,A,B,C,D,E>

Field Summary

Fields

Modifier and Type	Field	Description
private final PureIO<Void,E,A>	instance
private static final EIO<?,Unit>	UNIT

Constructor Summary

Constructors

Constructor	Description
EIO(PureIO<Void,E,A> value)

Method Summary

Modifier and Type	Method	Description
static <E, A> EIO<E,A>	absorb(EIO<E,Either<E,A>> value)
<B> EIO<E,B>	andThen(Kind<EIO<E,?>,? extends B> next)
<B> EIO<E,B>	ap(Kind<EIO<E,?>,? extends Function1<? super A,? extends B>> apply)
static <E, A> EIO<E,A>	async(Consumer1<Consumer1<? super Try<? extends Either<E,? extends A>>>> consumer)
<B, F> EIO<F,B>	bimap(Function1<? super E,? extends F> mapError, Function1<? super A,? extends B> map)
static <E, A extends AutoCloseable, B> EIO<E,B>	bracket(Kind<EIO<E,?>,? extends A> acquire, Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use)
static <E, A, B> EIO<E,B>	bracket(Kind<EIO<E,?>,? extends A> acquire, Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use, Consumer1<? super A> release)
static <E, A, B> EIO<E,B>	bracket(Kind<EIO<E,?>,? extends A> acquire, Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use, Function1<? super A,? extends Kind<EIO<E,?>,Unit>> release)
static <E, A> EIO<E,A>	cancellable(Function1<Consumer1<? super Try<? extends Either<E,? extends A>>>,EIO<E,Unit>> consumer)
static <E, A> EIO<E,A>	defer(Producer<Kind<EIO<E,?>,? extends A>> lazy)
static EIO<Throwable,Unit>	exec(CheckedRunnable task)
<B> EIO<E,B>	flatMap(Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> map)
<F> EIO<F,A>	flatMapError(Function1<? super E,? extends Kind<EIO<F,?>,? extends A>> map)
<B> UIO<B>	fold(Function1<? super E,? extends B> mapError, Function1<? super A,? extends B> map)
<B, F> EIO<F,B>	foldM(Function1<? super E,? extends Kind<EIO<F,?>,? extends B>> mapError, Function1<? super A,? extends Kind<EIO<F,?>,? extends B>> map)
EIO<E,Fiber<EIO<E,?>,A>>	fork()
static <E> EIO<E,Unit>	forked(Executor executor)
static <E, A> EIO<E,A>	fromEither(Producer<Either<E,? extends A>> task)
static <E, A> EIO<E,A>	fromEither(Either<E,? extends A> task)
static <A> EIO<Throwable,A>	fromOption(Producer<Option<? extends A>> task)
static <A> EIO<Throwable,A>	fromOption(Option<? extends A> task)
static <A> EIO<Throwable,A>	fromTry(Producer<Try<? extends A>> task)
static <A> EIO<Throwable,A>	fromTry(Try<? extends A> task)
static <A, B> Function1<A,EIO<Throwable,B>>	lift(Function1<? super A,? extends B> function)
static <E, A, B> Function1<A,EIO<E,B>>	liftEither(Function1<? super A,? extends Either<E,? extends B>> function)
static <A, B> Function1<A,EIO<Throwable,B>>	liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <A, B> Function1<A,EIO<Throwable,B>>	liftTry(Function1<? super A,? extends Try<? extends B>> function)
<B> EIO<E,B>	map(Function1<? super A,? extends B> map)
<B> EIO<B,A>	mapError(Function1<? super E,? extends B> map)
static <E, A> EIO<E,A>	never()
EIO<E,A>	orElse(EIO<E,? extends A> other)
static <E, A, B, C> EIO<E,C>	parMap2(Kind<EIO<E,?>,? extends A> za, Kind<EIO<E,?>,? extends B> zb, Function2<? super A,? super B,? extends C> mapper)
static <E, A, B, C> EIO<E,C>	parMap2(Executor executor, Kind<EIO<E,?>,? extends A> za, Kind<EIO<E,?>,? extends B> zb, Function2<? super A,? super B,? extends C> mapper)
static <E, A> EIO<E,A>	pure(A value)
static <E, A, B> EIO<E,Either<A,B>>	race(Kind<EIO<E,?>,? extends A> fa, Kind<EIO<E,?>,? extends B> fb)
static <E, A, B> EIO<E,Either<A,B>>	race(Executor executor, Kind<EIO<E,?>,? extends A> fa, Kind<EIO<E,?>,? extends B> fb)
static <E, A, B> EIO<E,Either<Tuple2<A,Fiber<EIO<E,?>,B>>,Tuple2<Fiber<EIO<E,?>,A>,B>>>	racePair(Executor executor, Kind<EIO<E,?>,? extends A> fa, Kind<EIO<E,?>,? extends B> fb)
static <E, A> EIO<E,A>	raiseError(E error)
UIO<A>	recover(Function1<? super E,? extends A> mapError)
<X extends Throwable> EIO<X,A>	refineOrDie(Class<X> type)
EIO<E,A>	repeat()
EIO<E,A>	repeat(int times)
EIO<E,A>	repeat(Duration delay)
EIO<E,A>	repeat(Duration delay, int times)
EIO<E,A>	retry()
EIO<E,A>	retry(int maxRetries)
EIO<E,A>	retry(Duration delay)
EIO<E,A>	retry(Duration delay, int maxRetries)
Future<Either<E,A>>	runAsync()
Future<Either<E,A>>	runAsync(Executor executor)
void	safeRunAsync(Consumer1<? super Try<? extends Either<E,? extends A>>> callback)
Either<E,A>	safeRunSync()
static <E> EIO<E,Unit>	sleep(Duration delay)
static <E> EIO<E,Unit>	sleep(Executor executor, Duration delay)
EIO<A,E>	swap()
static <A> EIO<Throwable,A>	task(Producer<? extends A> task)
static <E, A> EIO<E,A>	throwError(Throwable error)
EIO<E,Tuple2<Duration,A>>	timed()
EIO<E,A>	timeout(Duration duration)
EIO<E,A>	timeout(Executor executor, Duration duration)
<R> PureIO<R,E,A>	toPureIO()
UIO<A>	toUIO()
static <E, A> EIO<E,Sequence<A>>	traverse(Sequence<? extends Kind<EIO<E,?>,? extends A>> sequence)
static <E, A> EIO<E,Sequence<A>>	traverse(Executor executor, Sequence<? extends Kind<EIO<E,?>,? extends A>> sequence)
static <E> EIO<E,Unit>	unit()
<B> EIO<E,Tuple2<A,B>>	zip(Kind<EIO<E,?>,? extends B> other)
<B> EIO<E,A>	zipLeft(Kind<EIO<E,?>,? extends B> other)
<B> EIO<E,B>	zipRight(Kind<EIO<E,?>,? extends B> other)
<B, C> EIO<E,C>	zipWith(Kind<EIO<E,?>,? extends B> other, Function2<? super A,? super B,? extends C> mapper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.github.tonivade.purefun.Kind

fix, kind

Field Details

UNIT

private static final EIO<?,Unit> UNIT

instance

private final PureIO<Void,E,A> instance

Constructor Details

EIO

EIO(PureIO<Void,E,A> value)

Method Details

toPureIO

public <R> PureIO<R,E,A> toPureIO()

toUIO

public UIO<A> toUIO()

safeRunSync

public Either<E,A> safeRunSync()

runAsync

public Future<Either<E,A>> runAsync()

runAsync

public Future<Either<E,A>> runAsync(Executor executor)

safeRunAsync

public void safeRunAsync(Consumer1<? super Try<? extends Either<E,? extends A>>> callback)

map

public <B> EIO<E,B> map(Function1<? super A,? extends B> map)

Specified by:

map in interface Applicable<E,A>

Specified by:

map in interface Bindable<E,A>

Specified by:

map in interface Effect<E,A>

Specified by:

map in interface Mappable<E,A>

flatMap

public <B> EIO<E,B> flatMap(Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> map)

Specified by:

flatMap in interface Bindable<E,A>

Specified by:

flatMap in interface Effect<E,A>

andThen

public <B> EIO<E,B> andThen(Kind<EIO<E,?>,? extends B> next)

Specified by:

andThen in interface Bindable<E,A>

Specified by:

andThen in interface Effect<E,A>

ap

public <B> EIO<E,B> ap(Kind<EIO<E,?>,? extends Function1<? super A,? extends B>> apply)

Specified by:

ap in interface Applicable<E,A>

Specified by:

ap in interface Effect<E,A>

swap

public EIO<A,E> swap()

mapError

public <B> EIO<B,A> mapError(Function1<? super E,? extends B> map)

flatMapError

public <F> EIO<F,A> flatMapError(Function1<? super E,? extends Kind<EIO<F,?>,? extends A>> map)

bimap

public <B,
F> EIO<F,B> bimap(Function1<? super E,? extends F> mapError,
 Function1<? super A,? extends B> map)

foldM

public <B,
F> EIO<F,B> foldM(Function1<? super E,? extends Kind<EIO<F,?>,? extends B>> mapError,
 Function1<? super A,? extends Kind<EIO<F,?>,? extends B>> map)

fold

public <B> UIO<B> fold(Function1<? super E,? extends B> mapError,
 Function1<? super A,? extends B> map)

recover

public UIO<A> recover(Function1<? super E,? extends A> mapError)

orElse

public EIO<E,A> orElse(EIO<E,? extends A> other)

zip

public <B> EIO<E,Tuple2<A,B>> zip(Kind<EIO<E,?>,? extends B> other)

Specified by:

zip in interface Applicable<E,A>

Specified by:

zip in interface Effect<E,A>

zipLeft

public <B> EIO<E,A> zipLeft(Kind<EIO<E,?>,? extends B> other)

Specified by:

zipLeft in interface Applicable<E,A>

Specified by:

zipLeft in interface Effect<E,A>

zipRight

public <B> EIO<E,B> zipRight(Kind<EIO<E,?>,? extends B> other)

Specified by:

zipRight in interface Applicable<E,A>

Specified by:

zipRight in interface Effect<E,A>

zipWith

public <B,
C> EIO<E,C> zipWith(Kind<EIO<E,?>,? extends B> other,
 Function2<? super A,? super B,? extends C> mapper)

Specified by:

zipWith in interface Applicable<E,A>

Specified by:

zipWith in interface Effect<E,A>

fork

public EIO<E,Fiber<EIO<E,?>,A>> fork()

timeout

public EIO<E,A> timeout(Duration duration)

Specified by:

timeout in interface Effect<E,A>

timeout

public EIO<E,A> timeout(Executor executor,
 Duration duration)

repeat

public EIO<E,A> repeat()

Specified by:

repeat in interface Effect<E,A>

repeat

public EIO<E,A> repeat(int times)

Specified by:

repeat in interface Effect<E,A>

repeat

public EIO<E,A> repeat(Duration delay)

Specified by:

repeat in interface Effect<E,A>

repeat

public EIO<E,A> repeat(Duration delay,
 int times)

Specified by:

repeat in interface Effect<E,A>

retry

public EIO<E,A> retry()

Specified by:

retry in interface Effect<E,A>

retry

public EIO<E,A> retry(int maxRetries)

Specified by:

retry in interface Effect<E,A>

retry

public EIO<E,A> retry(Duration delay)

Specified by:

retry in interface Effect<E,A>

retry

public EIO<E,A> retry(Duration delay,
 int maxRetries)

Specified by:

retry in interface Effect<E,A>

timed

public EIO<E,Tuple2<Duration,A>> timed()

Specified by:

timed in interface Effect<E,A>

forked

public static <E> EIO<E,Unit> forked(Executor executor)

refineOrDie

public <X extends Throwable> EIO<X,A> refineOrDie(Class<X> type)

parMap2

public static <E,
A,
B,
C> EIO<E,C> parMap2(Kind<EIO<E,?>,? extends A> za,
 Kind<EIO<E,?>,? extends B> zb,
 Function2<? super A,? super B,? extends C> mapper)

parMap2

public static <E,
A,
B,
C> EIO<E,C> parMap2(Executor executor,
 Kind<EIO<E,?>,? extends A> za,
 Kind<EIO<E,?>,? extends B> zb,
 Function2<? super A,? super B,? extends C> mapper)

race

public static <E,
A,
B> EIO<E,Either<A,B>> race(Kind<EIO<E,?>,? extends A> fa,
 Kind<EIO<E,?>,? extends B> fb)

race

public static <E,
A,
B> EIO<E,Either<A,B>> race(Executor executor,
 Kind<EIO<E,?>,? extends A> fa,
 Kind<EIO<E,?>,? extends B> fb)

racePair

public static <E,
A,
B>
EIO<E,Either<Tuple2<A,Fiber<EIO<E,?>,B>>,Tuple2<Fiber<EIO<E,?>,A>,B>>> racePair(Executor executor,
 Kind<EIO<E,?>,? extends A> fa,
 Kind<EIO<E,?>,? extends B> fb)

absorb

public static <E,
A> EIO<E,A> absorb(EIO<E,Either<E,A>> value)

lift

public static <A,
B> Function1<A,EIO<Throwable,B>> lift(Function1<? super A,? extends B> function)

liftOption

public static <A,
B> Function1<A,EIO<Throwable,B>> liftOption(Function1<? super A,? extends Option<? extends B>> function)

liftTry

public static <A,
B> Function1<A,EIO<Throwable,B>> liftTry(Function1<? super A,? extends Try<? extends B>> function)

liftEither

public static <E,
A,
B> Function1<A,EIO<E,B>> liftEither(Function1<? super A,? extends Either<E,? extends B>> function)

fromOption

public static <A> EIO<Throwable,A> fromOption(Option<? extends A> task)

fromOption

public static <A> EIO<Throwable,A> fromOption(Producer<Option<? extends A>> task)

fromTry

public static <A> EIO<Throwable,A> fromTry(Try<? extends A> task)

fromTry

public static <A> EIO<Throwable,A> fromTry(Producer<Try<? extends A>> task)

fromEither

public static <E,
A> EIO<E,A> fromEither(Either<E,? extends A> task)

fromEither

public static <E,
A> EIO<E,A> fromEither(Producer<Either<E,? extends A>> task)

sleep

public static <E> EIO<E,Unit> sleep(Duration delay)

sleep

public static <E> EIO<E,Unit> sleep(Executor executor,
 Duration delay)

exec

public static EIO<Throwable,Unit> exec(CheckedRunnable task)

pure

public static <E,
A> EIO<E,A> pure(A value)

defer

public static <E,
A> EIO<E,A> defer(Producer<Kind<EIO<E,?>,? extends A>> lazy)

task

public static <A> EIO<Throwable,A> task(Producer<? extends A> task)

never

public static <E,
A> EIO<E,A> never()

async

public static <E,
A> EIO<E,A> async(Consumer1<Consumer1<? super Try<? extends Either<E,? extends A>>>> consumer)

cancellable

public static <E,
A> EIO<E,A> cancellable(Function1<Consumer1<? super Try<? extends Either<E,? extends A>>>,EIO<E,Unit>> consumer)

raiseError

public static <E,
A> EIO<E,A> raiseError(E error)

throwError

public static <E,
A> EIO<E,A> throwError(Throwable error)

traverse

public static <E,
A> EIO<E,Sequence<A>> traverse(Sequence<? extends Kind<EIO<E,?>,? extends A>> sequence)

traverse

public static <E,
A> EIO<E,Sequence<A>> traverse(Executor executor,
 Sequence<? extends Kind<EIO<E,?>,? extends A>> sequence)

bracket

public static <E,
A extends AutoCloseable,
B>
EIO<E,B> bracket(Kind<EIO<E,?>,? extends A> acquire,
 Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use)

bracket

public static <E,
A,
B> EIO<E,B> bracket(Kind<EIO<E,?>,? extends A> acquire,
 Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use,
 Consumer1<? super A> release)

bracket

public static <E,
A,
B> EIO<E,B> bracket(Kind<EIO<E,?>,? extends A> acquire,
 Function1<? super A,? extends Kind<EIO<E,?>,? extends B>> use,
 Function1<? super A,? extends Kind<EIO<E,?>,Unit>> release)

unit

public static <E> EIO<E,Unit> unit()