Trait/Object

cats.mtl

FunctorRaise

Related Docs: object FunctorRaise | package mtl

Permalink

trait FunctorRaise[F[_], E] extends Serializable

FunctorRaise[F, E] expresses the ability to raise errors of type E in a functorial F[_] context. This means that a value of type F[A] may contain no A values but instead an E error value, and further map calls will not have any values to execute the passed function on.

FunctorRaise has no external laws.

FunctorRaise has two internal laws:

def catchNonFatalDefault[A](a: => A)(f: Throwable => E)(implicit A: Applicative[F]) = {
  catchNonFatal(a)(f) <-> try {
    A.pure(a)
  } catch {
    case NonFatal(ex) => raise(f(ex))
  }
}

def ensureDefault[A](fa: F[A])(error: => E)(predicate: A => Boolean)(implicit A: Monad[F]) = {
  ensure(fa)(error)(predicate) <-> for {
    a <- fa
    _ <- if (predicate(a)) pure(()) else raise(error)
  } yield a
}

FunctorRaise has one free law, i.e. a law guaranteed by parametricity:

def failThenFlatMapFails[A, B](ex: E, f: A => F[B]) = {
  fail(ex).flatMap(f) <-> fail(ex)
}
guaranteed by:
  fail[X](ex) <-> fail[F[Y]](ex) // parametricity
  fail[X](ex).map(f) <-> fail[F[Y]](ex)  // map must have no effect, because there's no X value
  fail[X](ex).map(f).join <-> fail[F[Y]].join // add join to both sides
  fail(ex).flatMap(f) <-> fail(ex) // join is equal, because there's no inner value to flatten effects from
  // QED.
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FunctorRaise
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val functor: Functor[F]

    Permalink
  2. abstract def raise[A](e: E): F[A]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def catchNonFatal[A](a: ⇒ A)(f: (Throwable) ⇒ E)(implicit A: Applicative[F]): F[A]

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def ensure[A](fa: F[A])(error: ⇒ E)(predicate: (A) ⇒ Boolean)(implicit A: Monad[F]): F[A]

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped