Package com.github.tonivade.purefun.free

Interface Free<F extends Kind<F,?>,A>

All Superinterfaces:

Bindable<Free<F,?>,A>, FreeOf<F,A>, Kind<Free<F,?>,A>, Mappable<Free<F,?>,A>

All Known Implementing Classes:

Free.FlatMapped, Free.Pure, Free.Suspend

public sealed interface Free<F extends Kind<F,?>,A>
extends FreeOf<F,A>, Bindable<Free<F,?>,A>
permits Free.Pure<F,A>, Free.Suspend<F,A>, Free.FlatMapped<F,A,B>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	Free.FlatMapped<F extends Kind<F,?>,A,B>
static final record	Free.Pure<F extends Kind<F,?>,A>
static final record	Free.Suspend<F extends Kind<F,?>,A>

Method Summary

Modifier and Type	Method	Description
default <R> Free<F,R>	andThen(Kind<Free<F,?>,? extends R> next)
static <F extends Kind<F, ?>, T> Free<F,T>	defer(Producer<? extends Free<F,? extends T>> value)
<R> Free<F,R>	flatMap(Function1<? super A,? extends Kind<Free<F,?>,? extends R>> mapper)
default <G extends Kind<G, ?>> Kind<G,A>	foldMap(Monad<G> monad, FunctionK<F,G> interpreter)
private <G extends Kind<G, ?>> Kind<G,Either<Free<F,A>,A>>	foldStep(Monad<G> monad, FunctionK<F,G> interpreter)
static <F extends Kind<F, ?>, G extends Kind<G, ?>> FunctionK<F,Free<G,?>>	functionKF(FunctionK<F,G> functionK)
static <F extends Kind<F, ?>, G extends Kind<G, ?>, T> Free<G,T>	inject(InjectK<F,G> inject, Kind<F,T> value)
static <F extends Kind<F, ?>, T> Free<F,T>	liftF(Kind<F,? extends T> value)
default <R> Free<F,R>	map(Function1<? super A,? extends R> map)
static <F extends Kind<F, ?>> Monad<Free<F,?>>	monadF()
static <F extends Kind<F, ?>, T> Free<F,T>	pure(T value)

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

fix, kind

Method Details

pure

static <F extends Kind<F,
?>,
T> Free<F,T> pure(T value)

liftF

static <F extends Kind<F,
?>,
T> Free<F,T> liftF(Kind<F,? extends T> value)

inject

static <F extends Kind<F,
?>,
G extends Kind<G,
?>,
T>
Free<G,T> inject(InjectK<F,G> inject,
 Kind<F,T> value)

defer

static <F extends Kind<F,
?>,
T> Free<F,T> defer(Producer<? extends Free<F,? extends T>> value)

monadF

static <F extends Kind<F,
?>> Monad<Free<F,?>> monadF()

functionKF

static <F extends Kind<F,
?>,
G extends Kind<G,
?>>
FunctionK<F,Free<G,?>> functionKF(FunctionK<F,G> functionK)

map

default <R> Free<F,R> map(Function1<? super A,? extends R> map)

Specified by:

map in interface Bindable<F extends Kind<F,?>,A>

Specified by:

map in interface Mappable<F extends Kind<F,?>,A>

flatMap

<R> Free<F,R> flatMap(Function1<? super A,? extends Kind<Free<F,?>,? extends R>> mapper)

Specified by:

flatMap in interface Bindable<F extends Kind<F,?>,A>

andThen

default <R> Free<F,R> andThen(Kind<Free<F,?>,? extends R> next)

Specified by:

andThen in interface Bindable<F extends Kind<F,?>,A>

foldMap

default <G extends Kind<G,
?>> Kind<G,A> foldMap(Monad<G> monad,
 FunctionK<F,G> interpreter)

foldStep

private <G extends Kind<G,
?>>
Kind<G,Either<Free<F,A>,A>> foldStep(Monad<G> monad,
 FunctionK<F,G> interpreter)