Package com.github.tonivade.purefun.typeclasses

Interface MonadError<F extends Kind<F,?>,E>

All Superinterfaces:

Applicative<F>, ApplicativeError<F,E>, Functor<F>, Invariant<F>, Monad<F>, Selective<F>

All Known Subinterfaces:

Async<F>, Bracket<F,E>, Concurrent<F>, EIOAsync, EIOBracket<E>, EIOConcurrent, EIOMonadDefer, EIOMonadError<E>, EIOMonadThrow, EitherMonadError<L>, EitherMonadThrow, EitherTBracket<F,E>, EitherTMonadDefer<F>, EitherTMonadErrorFromMonad<F,E>, EitherTMonadErrorFromMonadError<F,E>, EitherTMonadThrowFromMonad<F>, EitherTMonadThrowFromMonadThrow<F>, EvalMonadError, EvalMonadThrow, FutureMonadThrow, IOAsync, IOBracket, IOConcurrent, IOMonadDefer, IOMonadError, IOMonadThrow, KleisliMonadError<F,R,E>, MonadDefer<F>, MonadThrow<F>, OptionMonadError, OptionTBracket<F>, OptionTMonadDefer<F>, OptionTMonadErrorFromMonad<F>, OptionTMonadErrorFromMonadError<F,E>, OptionTMonadThrow<F>, PureIOAsync<R>, PureIOBracket<R,E>, PureIOConcurrent<R>, PureIOMonadDefer<R>, PureIOMonadError<R,E>, PureIOMonadThrow<R>, RIOAsync<R>, RIOBracket<R>, RIOConcurrent<R>, RIOMonadDefer<R>, RIOMonadError<R>, RIOMonadThrow<R>, StateTMonadError<F,S,E>, TaskAsync, TaskBracket, TaskConcurrent, TaskMonadDefer, TaskMonadError, TaskMonadThrow, TryMonadError, TryMonadThrow, UIOAsync, UIOBracket, UIOConcurrent, UIOMonadDefer, UIOMonadError, UIOMonadThrow, URIOAsync<R>, URIOBracket<R>, URIOConcurrent<R>, URIOMonadDefer<R>, URIOMonadError<R>, URIOMonadThrow<R>, ValidationMonadError<E>, ValidationMonadThrow, WriterTMonadError<F,L,E>

All Known Implementing Classes:

EffectEMonadError, EffectRMonadError, MonadMTL

public interface MonadError<F extends Kind<F,?>,E>
extends ApplicativeError<F,E>, Monad<F>

Nested Class Summary

Nested classes/interfaces inherited from interface com.github.tonivade.purefun.typeclasses.Applicative

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

Method Summary

Modifier and Type	Method	Description
default <A> Kind<F,A>	ensure(Kind<F,A> value, Producer<E> error, Matcher1<A> matcher)
default <A, B> Kind<F,B>	repeat(Kind<F,A> value, Schedule<F,A,B> schedule)
private <A, B, C, S> Kind<F,Either<C,B>>	repeat(Kind<F,A> value, ScheduleImpl<F,S,A,B> schedule, Function2<E,Option<B>,Kind<F,C>> orElse)
default <A, B> Kind<F,B>	repeatOrElse(Kind<F,A> value, Schedule<F,A,B> schedule, Function2<E,Option<B>,Kind<F,B>> orElse)
default <A, B, C> Kind<F,Either<C,B>>	repeatOrElseEither(Kind<F,A> value, Schedule<F,A,B> schedule, Function2<E,Option<B>,Kind<F,C>> orElse)
default <A, B> Kind<F,A>	retry(Kind<F,A> value, Schedule<F,E,B> schedule)
private <A, B, S> Kind<F,Either<B,A>>	retry(Kind<F,A> value, ScheduleImpl<F,S,E,S> schedule, Function2<E,S,Kind<F,B>> orElse)
default <A, B> Kind<F,A>	retryOrElse(Kind<F,A> value, Schedule<F,E,B> schedule, Function2<E,B,Kind<F,A>> orElse)
default <A, B, C> Kind<F,Either<B,A>>	retryOrElseEither(Kind<F,A> value, Schedule<F,E,C> schedule, Function2<E,C,Kind<F,B>> orElse)

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Applicative

first, last, mapN, mapN, mapN, mapN, mapN, mapN, mapN, mapN, pure, tuple, tuple, tuple, tuple

Methods inherited from interface com.github.tonivade.purefun.typeclasses.ApplicativeError

attempt, fromEither, handleError, handleErrorWith, raiseError, recover, recoverWith

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Functor

imap, lift

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Monad

andThen, ap, flatMap, flatten, map, select, tailRecM, use

Methods inherited from interface com.github.tonivade.purefun.typeclasses.Selective

allS, allS, andS, anyS, anyS, branch, ifS, orS, whenS

Method Details

ensure

default <A> Kind<F,A> ensure(Kind<F,A> value,
 Producer<E> error,
 Matcher1<A> matcher)

repeat

default <A,
B> Kind<F,B> repeat(Kind<F,A> value,
 Schedule<F,A,B> schedule)

repeatOrElse

default <A,
B> Kind<F,B> repeatOrElse(Kind<F,A> value,
 Schedule<F,A,B> schedule,
 Function2<E,Option<B>,Kind<F,B>> orElse)

repeatOrElseEither

default <A,
B,
C> Kind<F,Either<C,B>> repeatOrElseEither(Kind<F,A> value,
 Schedule<F,A,B> schedule,
 Function2<E,Option<B>,Kind<F,C>> orElse)

retry

default <A,
B> Kind<F,A> retry(Kind<F,A> value,
 Schedule<F,E,B> schedule)

retryOrElse

default <A,
B> Kind<F,A> retryOrElse(Kind<F,A> value,
 Schedule<F,E,B> schedule,
 Function2<E,B,Kind<F,A>> orElse)

retryOrElseEither

default <A,
B,
C> Kind<F,Either<B,A>> retryOrElseEither(Kind<F,A> value,
 Schedule<F,E,C> schedule,
 Function2<E,C,Kind<F,B>> orElse)

repeat

private <A,
B,
C,
S> Kind<F,Either<C,B>> repeat(Kind<F,A> value,
 ScheduleImpl<F,S,A,B> schedule,
 Function2<E,Option<B>,Kind<F,C>> orElse)

retry

private <A,
B,
S> Kind<F,Either<B,A>> retry(Kind<F,A> value,
 ScheduleImpl<F,S,E,S> schedule,
 Function2<E,S,Kind<F,B>> orElse)