Package com.github.tonivade.purefun.effect

Class UIO<A>

java.lang.Object

com.github.tonivade.purefun.effect.UIO<A>

All Implemented Interfaces:

Applicable<UIO<?>,A>, Bindable<UIO<?>,A>, Effect<UIO<?>,A>, Mappable<UIO<?>,A>, Recoverable, UIOOf<A>, Kind<UIO<?>,A>

public final class UIO<A>
extends Object
implements UIOOf<A>, Effect<UIO<?>,A>, Recoverable

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,Void,A>	instance
private static final UIO<Unit>	UNIT

Constructor Summary

Constructors

Constructor	Description
UIO(PureIO<Void,Void,A> value)

Method Summary

Modifier and Type	Method	Description
<B> UIO<B>	andThen(Kind<UIO<?>,? extends B> next)
<B> UIO<B>	ap(Kind<UIO<?>,? extends Function1<? super A,? extends B>> apply)
static <A> UIO<A>	async(Consumer1<Consumer1<? super Try<? extends A>>> consumer)
static <A extends AutoCloseable, B> UIO<B>	bracket(Kind<UIO<?>,? extends A> acquire, Function1<? super A,? extends Kind<UIO<?>,? extends B>> use)
static <A, B> UIO<B>	bracket(Kind<UIO<?>,? extends A> acquire, Function1<? super A,? extends Kind<UIO<?>,? extends B>> use, Consumer1<? super A> release)
static <A, B> UIO<B>	bracket(Kind<UIO<?>,? extends A> acquire, Function1<? super A,? extends Kind<UIO<?>,? extends B>> use, Function1<? super A,? extends Kind<UIO<?>,Unit>> release)
static <A> UIO<A>	cancellable(Function1<Consumer1<? super Try<? extends A>>,UIO<Unit>> consumer)
static <A> UIO<A>	defer(Producer<Kind<UIO<?>,? extends A>> lazy)
static UIO<Unit>	exec(CheckedRunnable task)
<B> UIO<B>	flatMap(Function1<? super A,? extends Kind<UIO<?>,? extends B>> map)
private static <A> UIO<A>	fold(PureIO<Void,Throwable,A> zio)
UIO<Fiber<UIO<?>,A>>	fork()
static UIO<Unit>	forked(Executor executor)
static <T> UIO<T>	fromEither(Either<Throwable,? extends T> task)
static <T> UIO<T>	fromOption(Option<? extends T> task)
static <T> UIO<T>	fromPromise(Promise<? extends T> promise)
static <T> UIO<T>	fromTry(Try<? extends T> task)
static <A, B> Function1<A,UIO<B>>	lift(Function1<? super A,? extends B> function)
static <A, B> Function1<A,UIO<B>>	liftEither(Function1<? super A,? extends Either<Throwable,? extends B>> function)
static <A, B> Function1<A,UIO<B>>	liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <A, B> Function1<A,UIO<B>>	liftTry(Function1<? super A,? extends Try<? extends B>> function)
<B> UIO<B>	map(Function1<? super A,? extends B> map)
static <A, T> UIO<Function1<A,UIO<T>>>	memoize(Function1<A,UIO<T>> function)
static <A, T> UIO<Function1<A,UIO<T>>>	memoize(Executor executor, Function1<A,UIO<T>> function)
static <A> UIO<A>	never()
static <A, B, C> UIO<C>	parMap2(Kind<UIO<?>,? extends A> za, Kind<UIO<?>,? extends B> zb, Function2<? super A,? super B,? extends C> mapper)
static <A, B, C> UIO<C>	parMap2(Executor executor, Kind<UIO<?>,? extends A> za, Kind<UIO<?>,? extends B> zb, Function2<? super A,? super B,? extends C> mapper)
static <A> UIO<A>	pure(A value)
static <A, B> UIO<Either<A,B>>	race(Kind<UIO<?>,? extends A> fa, Kind<UIO<?>,? extends B> fb)
static <A, B> UIO<Either<A,B>>	race(Executor executor, Kind<UIO<?>,? extends A> fa, Kind<UIO<?>,? extends B> fb)
static <A, B> UIO<Either<Tuple2<A,Fiber<UIO<?>,B>>,Tuple2<Fiber<UIO<?>,A>,B>>>	racePair(Executor executor, Kind<UIO<?>,? extends A> fa, Kind<UIO<?>,? extends B> fb)
static <A> UIO<A>	raiseError(Throwable throwable)
UIO<A>	recover(Function1<? super Throwable,? extends A> mapError)
<X extends Throwable> UIO<A>	recoverWith(Class<X> type, Function1<? super X,? extends A> function)
<B> UIO<B>	redeem(Function1<? super Throwable,? extends B> mapError, Function1<? super A,? extends B> map)
<B> UIO<B>	redeemWith(Function1<? super Throwable,? extends Kind<UIO<?>,? extends B>> mapError, Function1<? super A,? extends Kind<UIO<?>,? extends B>> map)
UIO<A>	repeat()
UIO<A>	repeat(int times)
private static <T> UIO<T>	repeat(UIO<T> self, UIO<Unit> pause, int times)
UIO<A>	repeat(Duration delay)
UIO<A>	repeat(Duration delay, int times)
UIO<A>	retry()
UIO<A>	retry(int maxRetries)
private static <T> UIO<T>	retry(UIO<T> self, UIO<Unit> pause, int maxRetries)
UIO<A>	retry(Duration delay)
UIO<A>	retry(Duration delay, int maxRetries)
Future<A>	runAsync()
Future<A>	runAsync(Executor executor)
void	safeRunAsync(Consumer1<? super Try<? extends A>> callback)
void	safeRunAsync(Executor executor, Consumer1<? super Try<? extends A>> callback)
Try<A>	safeRunSync()
static UIO<Unit>	sleep(Duration delay)
static UIO<Unit>	sleep(Executor executor, Duration delay)
static <A> UIO<A>	task(Producer<? extends A> task)
UIO<Tuple2<Duration,A>>	timed()
UIO<A>	timeout(Duration duration)
UIO<A>	timeout(Executor executor, Duration duration)
<E> EIO<E,A>	toEIO()
<R, E> PureIO<R,E,A>	toPureIO()
<R> RIO<R,A>	toRIO()
Task<A>	toTask()
<R> URIO<R,A>	toURIO()
static <A> UIO<Sequence<A>>	traverse(Sequence<? extends Kind<UIO<?>,A>> sequence)
static <A> UIO<Sequence<A>>	traverse(Executor executor, Sequence<? extends Kind<UIO<?>,A>> sequence)
static UIO<Unit>	unit()
A	unsafeRunSync()
<B> UIO<Tuple2<A,B>>	zip(Kind<UIO<?>,? extends B> other)
<B> UIO<A>	zipLeft(Kind<UIO<?>,? extends B> other)
<B> UIO<B>	zipRight(Kind<UIO<?>,? extends B> other)
<B, C> UIO<C>	zipWith(Kind<UIO<?>,? 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

Methods inherited from interface com.github.tonivade.purefun.core.Recoverable

sneakyThrow

Field Details

UNIT

private static final UIO<Unit> UNIT

instance

private final PureIO<Void,Void,A> instance

Constructor Details

UIO

UIO(PureIO<Void,Void,A> value)

Method Details

runAsync

public Future<A> runAsync()

runAsync

public Future<A> runAsync(Executor executor)

unsafeRunSync

public A unsafeRunSync()

safeRunSync

public Try<A> safeRunSync()

toPureIO

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

toEIO

public <E> EIO<E,A> toEIO()

toRIO

public <R> RIO<R,A> toRIO()

toURIO

public <R> URIO<R,A> toURIO()

toTask

public Task<A> toTask()

safeRunAsync

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

safeRunAsync

public void safeRunAsync(Executor executor,
 Consumer1<? super Try<? extends A>> callback)

map

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

Specified by:

map in interface Applicable<UIO<?>,A>

Specified by:

map in interface Bindable<UIO<?>,A>

Specified by:

map in interface Effect<UIO<?>,A>

Specified by:

map in interface Mappable<UIO<?>,A>

flatMap

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

Specified by:

flatMap in interface Bindable<UIO<?>,A>

Specified by:

flatMap in interface Effect<UIO<?>,A>

andThen

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

Specified by:

andThen in interface Bindable<UIO<?>,A>

Specified by:

andThen in interface Effect<UIO<?>,A>

ap

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

Specified by:

ap in interface Applicable<UIO<?>,A>

Specified by:

ap in interface Effect<UIO<?>,A>

recover

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

recoverWith

public <X extends Throwable> UIO<A> recoverWith(Class<X> type,
 Function1<? super X,? extends A> function)

redeem

public <B> UIO<B> redeem(Function1<? super Throwable,? extends B> mapError,
 Function1<? super A,? extends B> map)

redeemWith

public <B> UIO<B> redeemWith(Function1<? super Throwable,? extends Kind<UIO<?>,? extends B>> mapError,
 Function1<? super A,? extends Kind<UIO<?>,? extends B>> map)

zip

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

Specified by:

zip in interface Applicable<UIO<?>,A>

Specified by:

zip in interface Effect<UIO<?>,A>

zipLeft

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

Specified by:

zipLeft in interface Applicable<UIO<?>,A>

Specified by:

zipLeft in interface Effect<UIO<?>,A>

zipRight

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

Specified by:

zipRight in interface Applicable<UIO<?>,A>

Specified by:

zipRight in interface Effect<UIO<?>,A>

zipWith

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

Specified by:

zipWith in interface Applicable<UIO<?>,A>

Specified by:

zipWith in interface Effect<UIO<?>,A>

fork

public UIO<Fiber<UIO<?>,A>> fork()

timeout

public UIO<A> timeout(Duration duration)

Specified by:

timeout in interface Effect<UIO<?>,A>

timeout

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

repeat

public UIO<A> repeat()

Specified by:

repeat in interface Effect<UIO<?>,A>

repeat

public UIO<A> repeat(int times)

Specified by:

repeat in interface Effect<UIO<?>,A>

repeat

public UIO<A> repeat(Duration delay)

Specified by:

repeat in interface Effect<UIO<?>,A>

repeat

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

Specified by:

repeat in interface Effect<UIO<?>,A>

retry

public UIO<A> retry()

Specified by:

retry in interface Effect<UIO<?>,A>

retry

public UIO<A> retry(int maxRetries)

Specified by:

retry in interface Effect<UIO<?>,A>

retry

public UIO<A> retry(Duration delay)

Specified by:

retry in interface Effect<UIO<?>,A>

retry

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

Specified by:

retry in interface Effect<UIO<?>,A>

timed

public UIO<Tuple2<Duration,A>> timed()

Specified by:

timed in interface Effect<UIO<?>,A>

forked

public static UIO<Unit> forked(Executor executor)

parMap2

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

parMap2

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

race

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

race

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

racePair

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

lift

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

liftOption

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

liftTry

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

liftEither

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

sleep

public static UIO<Unit> sleep(Duration delay)

sleep

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

exec

public static UIO<Unit> exec(CheckedRunnable task)

pure

public static <A> UIO<A> pure(A value)

raiseError

public static <A> UIO<A> raiseError(Throwable throwable)

defer

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

task

public static <A> UIO<A> task(Producer<? extends A> task)

fromOption

public static <T> UIO<T> fromOption(Option<? extends T> task)

fromTry

public static <T> UIO<T> fromTry(Try<? extends T> task)

fromEither

public static <T> UIO<T> fromEither(Either<Throwable,? extends T> task)

fromPromise

public static <T> UIO<T> fromPromise(Promise<? extends T> promise)

never

public static <A> UIO<A> never()

async

public static <A> UIO<A> async(Consumer1<Consumer1<? super Try<? extends A>>> consumer)

cancellable

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

memoize

public static <A,
T> UIO<Function1<A,UIO<T>>> memoize(Function1<A,UIO<T>> function)

memoize

public static <A,
T> UIO<Function1<A,UIO<T>>> memoize(Executor executor,
 Function1<A,UIO<T>> function)

traverse

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

traverse

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

bracket

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

bracket

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

bracket

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

unit

public static UIO<Unit> unit()

fold

private static <A> UIO<A> fold(PureIO<Void,Throwable,A> zio)

repeat

private static <T> UIO<T> repeat(UIO<T> self,
 UIO<Unit> pause,
 int times)

retry

private static <T> UIO<T> retry(UIO<T> self,
 UIO<Unit> pause,
 int maxRetries)