trait MonadError[F[_], E] extends Serializable with Type[F]
The MonadError type-class describes monads that can do error handling.
To implement MonadError:
- inherit from MonadError.Type in derived type-classes
- inherit from MonadError.Instance when implementing instances
The purpose of this type-class is to support the data-types in the Monix library and it is considered a shim for a lawful type-class to be supplied by libraries such as Cats or Scalaz or equivalent.
CREDITS: The type-class encoding has been inspired by the Scato project by Aloïs Cochard and Scalaz 8 and the type has been extracted from Cats.
- Self Type
- Instance[F, E]
- Source
- MonadError.scala
- Alphabetic
- By Inheritance
- MonadError
- Type
- Type
- Type
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
implicit abstract
def
applicative: Applicative[F]
- Definition Classes
- Type
-
implicit abstract
def
functor: Functor[F]
- Definition Classes
- Type
-
implicit abstract
def
monad: Monad[F]
- Definition Classes
- Type
-
abstract
def
onErrorHandle[A](fa: F[A])(f: (E) ⇒ A): F[A]
Handle any error, by mapping it to an
Avalue. -
abstract
def
onErrorHandleWith[A](fa: F[A])(f: (E) ⇒ F[A]): F[A]
Handle any error, potentially recovering from it, by mapping it to an
F[A]value. -
abstract
def
onErrorRecover[A](fa: F[A])(pf: PartialFunction[E, A]): F[A]
Recover from certain errors by mapping them to an
Avalue. -
abstract
def
onErrorRecoverWith[A](fa: F[A])(pf: PartialFunction[E, F[A]]): F[A]
Recover from certain errors by mapping them to an
F[A]value. -
abstract
def
raiseError[A](e: E): F[A]
Lift an error into the
Fcontext.
Concrete Value Members
-
def
attempt[A](fa: F[A]): F[Either[E, A]]
Handle errors by exposing them into
Eithervalues.Handle errors by exposing them into
Eithervalues.Returns
Right(value)for successful values orLeft(error)in case a failure happened.
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observablepattern:Observableimplementationsmonix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.
monix.cats is the optional integration with the Cats library, providing translations for the types described in
monix.types.monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in
monix.types.