Package com.github.tonivade.purefun.monad

Interface IO<T>

All Superinterfaces:

Applicable<IO<?>,T>, Bindable<IO<?>,T>, Effect<IO<?>,T>, IOOf<T>, Kind<IO<?>,T>, Mappable<IO<?>,T>, Recoverable

All Known Implementing Classes:

IO.Async, IO.Delay, IO.Failure, IO.FlatMapped, IO.Pure, IO.Recover, IO.Suspend

public sealed interface IO<T>
extends IOOf<T>, Effect<IO<?>,T>, Recoverable
permits IO.Pure<T>, IO.Failure<T>, IO.FlatMapped<T,R>, IO.Delay<T>, IO.Async<T>, IO.Suspend<T>, IO.Recover<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IO.Async<T>
static final class	IO.Delay<T>
static final class	IO.Failure<T>
static final class	IO.FlatMapped<T,R>
static final class	IO.Pure<T>
static final class	IO.Recover<T>
static final class	IO.Suspend<T>

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
static final IO<Unit>	UNIT

Method Summary

Modifier and Type	Method	Description
default <R> IO<R>	andThen(Kind<IO<?>,? extends R> after)
default <R> IO<R>	ap(Kind<IO<?>,? extends Function1<? super T,? extends R>> apply)
static <T> IO<T>	async(Consumer1<Consumer1<? super Try<? extends T>>> callback)
default IO<Try<T>>	attempt()
static <T extends AutoCloseable, R> IO<R>	bracket(Kind<IO<?>,? extends T> acquire, Function1<? super T,? extends Kind<IO<?>,? extends R>> use)
static <T, R> IO<R>	bracket(Kind<IO<?>,? extends T> acquire, Function1<? super T,? extends Kind<IO<?>,? extends R>> use, Consumer1<? super T> release)
static <T, R> IO<R>	bracket(Kind<IO<?>,? extends T> acquire, Function1<? super T,? extends Kind<IO<?>,? extends R>> use, Function1<? super T,? extends Kind<IO<?>,Unit>> release)
static <T> IO<T>	cancellable(Function1<Consumer1<? super Try<? extends T>>,Kind<IO<?>,Unit>> callback)
static <T> IO<T>	delay(Duration delay, Producer<? extends T> lazy)
default IO<Either<Throwable,T>>	either()
default <L, R> IO<Either<L,R>>	either(Function1<? super Throwable,? extends L> mapError, Function1<? super T,? extends R> mapper)
static IO<Unit>	exec(CheckedRunnable task)
private static <T> Promise<T>	executeAsync(IO.Async<T> current, IOConnection connection, Promise<T> promise)
default <R> IO<R>	flatMap(Function1<? super T,? extends Kind<IO<?>,? extends R>> map)
default IO<Fiber<IO<?>,T>>	fork()
static IO<Unit>	forked()
static IO<Unit>	forked(Executor executor)
static <T> IO<T>	fromCompletableFuture(CompletableFuture<? extends T> promise)
static <T> IO<T>	fromEither(Either<Throwable,? extends T> task)
static <T> IO<T>	fromOption(Option<? extends T> task)
static <T> IO<T>	fromPromise(Promise<? extends T> promise)
static <T> IO<T>	fromTry(Try<? extends T> task)
static <T, R> Function1<T,IO<R>>	lift(Function1<T,R> task)
static <A, B> Function1<A,IO<B>>	liftEither(Function1<? super A,? extends Either<Throwable,? extends B>> function)
static <A, B> Function1<A,IO<B>>	liftOption(Function1<? super A,? extends Option<? extends B>> function)
static <A, B> Function1<A,IO<B>>	liftTry(Function1<? super A,? extends Try<? extends B>> function)
default <R> IO<R>	map(Function1<? super T,? extends R> map)
static <A, T> IO<Function1<A,IO<T>>>	memoize(Function1<A,IO<T>> function)
static <A, T> IO<Function1<A,IO<T>>>	memoize(Executor executor, Function1<A,IO<T>> function)
static <T> IO<T>	never()
static <A, B, C> IO<C>	parMap2(Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb, Function2<? super A,? super B,? extends C> mapper)
static <A, B, C> IO<C>	parMap2(Executor executor, Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb, Function2<? super A,? super B,? extends C> mapper)
static <T> IO<T>	pure(T value)
static <A, B> IO<Either<A,B>>	race(Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb)
static <A, B> IO<Either<A,B>>	race(Executor executor, Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb)
static <A, B> IO<Either<Tuple2<A,Fiber<IO<?>,B>>,Tuple2<Fiber<IO<?>,A>,B>>>	racePair(Executor executor, Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb)
static <T> IO<T>	raiseError(Throwable error)
default IO<T>	recover(Function1<? super Throwable,? extends T> mapError)
default <X extends Throwable> IO<T>	recover(Class<X> type, Function1<? super X,? extends T> function)
default IO<T>	recoverWith(PartialFunction1<? super Throwable,? extends Kind<IO<?>,? extends T>> mapper)
default <R> IO<R>	redeem(Function1<? super Throwable,? extends R> mapError, Function1<? super T,? extends R> mapper)
default <R> IO<R>	redeemWith(Function1<? super Throwable,? extends Kind<IO<?>,? extends R>> mapError, Function1<? super T,? extends Kind<IO<?>,? extends R>> mapper)
default IO<T>	repeat()
default IO<T>	repeat(int times)
private static <T> IO<T>	repeat(IO<T> self, IO<Unit> pause, int times)
default IO<T>	repeat(Duration delay)
default IO<T>	repeat(Duration delay, int times)
default IO<T>	retry()
default IO<T>	retry(int maxRetries)
private static <T> IO<T>	retry(IO<T> self, IO<Unit> pause, int maxRetries)
default IO<T>	retry(Duration delay)
default IO<T>	retry(Duration delay, int maxRetries)
default Future<T>	runAsync()
private static <T> Promise<T>	runAsync(Kind<IO<?>,T> current, IOConnection connection)
private static <T, U, V> Promise<T>	runAsync(Kind<IO<?>,T> current, IOConnection connection, CallStack<T> stack, Promise<T> promise)
default Future<T>	runAsync(Executor executor)
default void	safeRunAsync(Consumer1<? super Try<? extends T>> callback)
default void	safeRunAsync(Executor executor, Consumer1<? super Try<? extends T>> callback)
default Try<T>	safeRunSync()
static IO<Unit>	sequence(Sequence<? extends Kind<IO<?>,?>> sequence)
static IO<Unit>	sleep(Duration duration)
static IO<Unit>	sleep(Executor executor, Duration duration)
static <T> IO<T>	suspend(Producer<? extends Kind<IO<?>,? extends T>> lazy)
static <T> IO<T>	task(Producer<? extends T> producer)
default IO<Tuple2<Duration,T>>	timed()
default IO<T>	timeout(Duration duration)
default IO<T>	timeout(Executor executor, Duration duration)
static <A> IO<Sequence<A>>	traverse(Sequence<? extends Kind<IO<?>,A>> sequence)
static <A> IO<Sequence<A>>	traverse(Executor executor, Sequence<? extends Kind<IO<?>,A>> sequence)
static <A, B> IO<Tuple2<A,B>>	tuple(Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb)
static <A, B> IO<Tuple2<A,B>>	tuple(Executor executor, Kind<IO<?>,? extends A> fa, Kind<IO<?>,? extends B> fb)
static IO<Unit>	unit()
default T	unsafeRunSync()
private static <T, U> Kind<IO<?>,T>	unwrap(Kind<IO<?>,T> current, CallStack<U> stack, Function1<Kind<IO<?>,? extends T>,Kind<IO<?>,? extends U>> next)

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

zip, zipLeft, zipRight, zipWith

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

static final IO<Unit> UNIT

Method Details

runAsync

default Future<T> runAsync()

runAsync

default Future<T> runAsync(Executor executor)

unsafeRunSync

default T unsafeRunSync()

safeRunSync

default Try<T> safeRunSync()

safeRunAsync

default void safeRunAsync(Consumer1<? super Try<? extends T>> callback)

safeRunAsync

default void safeRunAsync(Executor executor,
 Consumer1<? super Try<? extends T>> callback)

map

default <R> IO<R> map(Function1<? super T,? extends R> map)

Specified by:

map in interface Applicable<IO<?>,T>

Specified by:

map in interface Bindable<IO<?>,T>

Specified by:

map in interface Effect<IO<?>,T>

Specified by:

map in interface Mappable<IO<?>,T>

flatMap

default <R> IO<R> flatMap(Function1<? super T,? extends Kind<IO<?>,? extends R>> map)

Specified by:

flatMap in interface Bindable<IO<?>,T>

Specified by:

flatMap in interface Effect<IO<?>,T>

andThen

default <R> IO<R> andThen(Kind<IO<?>,? extends R> after)

Specified by:

andThen in interface Bindable<IO<?>,T>

Specified by:

andThen in interface Effect<IO<?>,T>

ap

default <R> IO<R> ap(Kind<IO<?>,? extends Function1<? super T,? extends R>> apply)

Specified by:

ap in interface Applicable<IO<?>,T>

Specified by:

ap in interface Effect<IO<?>,T>

attempt

default IO<Try<T>> attempt()

either

default IO<Either<Throwable,T>> either()

either

default <L,
R> IO<Either<L,R>> either(Function1<? super Throwable,? extends L> mapError,
 Function1<? super T,? extends R> mapper)

redeem

default <R> IO<R> redeem(Function1<? super Throwable,? extends R> mapError,
 Function1<? super T,? extends R> mapper)

redeemWith

default <R> IO<R> redeemWith(Function1<? super Throwable,? extends Kind<IO<?>,? extends R>> mapError,
 Function1<? super T,? extends Kind<IO<?>,? extends R>> mapper)

recover

default IO<T> recover(Function1<? super Throwable,? extends T> mapError)

recover

default <X extends Throwable> IO<T> recover(Class<X> type,
 Function1<? super X,? extends T> function)

recoverWith

default IO<T> recoverWith(PartialFunction1<? super Throwable,? extends Kind<IO<?>,? extends T>> mapper)

timed

default IO<Tuple2<Duration,T>> timed()

Specified by:

timed in interface Effect<IO<?>,T>

fork

default IO<Fiber<IO<?>,T>> fork()

timeout

default IO<T> timeout(Duration duration)

Specified by:

timeout in interface Effect<IO<?>,T>

timeout

default IO<T> timeout(Executor executor,
 Duration duration)

repeat

default IO<T> repeat()

Specified by:

repeat in interface Effect<IO<?>,T>

repeat

default IO<T> repeat(int times)

Specified by:

repeat in interface Effect<IO<?>,T>

repeat

default IO<T> repeat(Duration delay)

Specified by:

repeat in interface Effect<IO<?>,T>

repeat

default IO<T> repeat(Duration delay,
 int times)

Specified by:

repeat in interface Effect<IO<?>,T>

retry

default IO<T> retry()

Specified by:

retry in interface Effect<IO<?>,T>

retry

default IO<T> retry(int maxRetries)

Specified by:

retry in interface Effect<IO<?>,T>

retry

default IO<T> retry(Duration delay)

Specified by:

retry in interface Effect<IO<?>,T>

retry

default IO<T> retry(Duration delay,
 int maxRetries)

Specified by:

retry in interface Effect<IO<?>,T>

pure

static <T> IO<T> pure(T value)

race

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

race

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

racePair

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

raiseError

static <T> IO<T> raiseError(Throwable error)

delay

static <T> IO<T> delay(Duration delay,
 Producer<? extends T> lazy)

suspend

static <T> IO<T> suspend(Producer<? extends Kind<IO<?>,? extends T>> lazy)

lift

static <T,
R> Function1<T,IO<R>> lift(Function1<T,R> task)

liftOption

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

liftTry

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

liftEither

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

fromOption

static <T> IO<T> fromOption(Option<? extends T> task)

fromTry

static <T> IO<T> fromTry(Try<? extends T> task)

fromEither

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

fromPromise

static <T> IO<T> fromPromise(Promise<? extends T> promise)

fromCompletableFuture

static <T> IO<T> fromCompletableFuture(CompletableFuture<? extends T> promise)

sleep

static IO<Unit> sleep(Duration duration)

sleep

static IO<Unit> sleep(Executor executor,
 Duration duration)

exec

static IO<Unit> exec(CheckedRunnable task)

task

static <T> IO<T> task(Producer<? extends T> producer)

never

static <T> IO<T> never()

forked

static IO<Unit> forked()

forked

static IO<Unit> forked(Executor executor)

async

static <T> IO<T> async(Consumer1<Consumer1<? super Try<? extends T>>> callback)

cancellable

static <T> IO<T> cancellable(Function1<Consumer1<? super Try<? extends T>>,Kind<IO<?>,Unit>> callback)

memoize

static <A,
T> IO<Function1<A,IO<T>>> memoize(Function1<A,IO<T>> function)

memoize

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

unit

static IO<Unit> unit()

bracket

static <T,
R> IO<R> bracket(Kind<IO<?>,? extends T> acquire,
 Function1<? super T,? extends Kind<IO<?>,? extends R>> use,
 Function1<? super T,? extends Kind<IO<?>,Unit>> release)

bracket

static <T,
R> IO<R> bracket(Kind<IO<?>,? extends T> acquire,
 Function1<? super T,? extends Kind<IO<?>,? extends R>> use,
 Consumer1<? super T> release)

bracket

static <T extends AutoCloseable,
R> IO<R> bracket(Kind<IO<?>,? extends T> acquire,
 Function1<? super T,? extends Kind<IO<?>,? extends R>> use)

sequence

static IO<Unit> sequence(Sequence<? extends Kind<IO<?>,?>> sequence)

traverse

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

traverse

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

parMap2

static <A,
B,
C> IO<C> parMap2(Kind<IO<?>,? extends A> fa,
 Kind<IO<?>,? extends B> fb,
 Function2<? super A,? super B,? extends C> mapper)

parMap2

static <A,
B,
C> IO<C> parMap2(Executor executor,
 Kind<IO<?>,? extends A> fa,
 Kind<IO<?>,? extends B> fb,
 Function2<? super A,? super B,? extends C> mapper)

tuple

static <A,
B> IO<Tuple2<A,B>> tuple(Kind<IO<?>,? extends A> fa,
 Kind<IO<?>,? extends B> fb)

tuple

static <A,
B> IO<Tuple2<A,B>> tuple(Executor executor,
 Kind<IO<?>,? extends A> fa,
 Kind<IO<?>,? extends B> fb)

runAsync

private static <T> Promise<T> runAsync(Kind<IO<?>,T> current,
 IOConnection connection)

runAsync

private static <T,
U,
V> Promise<T> runAsync(Kind<IO<?>,T> current,
 IOConnection connection,
 CallStack<T> stack,
 Promise<T> promise)

unwrap

private static <T,
U> Kind<IO<?>,T> unwrap(Kind<IO<?>,T> current,
 CallStack<U> stack,
 Function1<Kind<IO<?>,? extends T>,Kind<IO<?>,? extends U>> next)

executeAsync

private static <T> Promise<T> executeAsync(IO.Async<T> current,
 IOConnection connection,
 Promise<T> promise)

repeat

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

retry

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