Trait/Object

cats.mtl

MonadLayerControl

Related Docs: object MonadLayerControl | package mtl

Permalink

trait MonadLayerControl[M[_], Inner[_]] extends MonadLayerFunctor[M, Inner]

MonadLayerControl is possible to use to access lower monad layers in invariant position, as in so-called "control operations".

Three external laws:

def layerMapRespectsLayerControl[A](m: M[A], f: Inner ~> Inner) = {
  layerMapK(m)(f) <-> layerControl(run => f(run(m)).flatMap(restore)
}

def distributionLaw[A](nt: State ~> State, st: State[A]) = {
  restore(nt(st)) <-> layerControl[State[A]](_ (restore(st)).map(nt(_))).flatMap(restore)
}

def layerControlIdentity[A](ma: M[A]) = {
  ma <->
    layerControl[Inner[State[A]]] { cps =>
      cps(ma).pure[Inner]
    }.flatMap(layer).flatMap(restore)
}
Linear Supertypes
MonadLayerFunctor[M, Inner], ApplicativeLayerFunctor[M, Inner], FunctorLayerFunctor[M, Inner], MonadLayer[M, Inner], ApplicativeLayer[M, Inner], FunctorLayer[M, Inner], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MonadLayerControl
  2. MonadLayerFunctor
  3. ApplicativeLayerFunctor
  4. FunctorLayerFunctor
  5. MonadLayer
  6. ApplicativeLayer
  7. FunctorLayer
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type State[A]

    Permalink

Abstract Value Members

  1. abstract val innerInstance: Monad[Inner]

    Permalink
    Definition Classes
    MonadLayerApplicativeLayerFunctorLayer
  2. abstract def layer[A](inner: Inner[A]): M[A]

    Permalink
    Definition Classes
    FunctorLayer
  3. abstract def layerControl[A](cps: (~>[M, [A]Inner[State[A]]]) ⇒ Inner[A]): M[A]

    Permalink
  4. abstract def layerMapK[A](ma: M[A])(trans: ~>[Inner, Inner]): M[A]

    Permalink
    Definition Classes
    FunctorLayerFunctor
  5. abstract val outerInstance: Monad[M]

    Permalink
    Definition Classes
    MonadLayerApplicativeLayerFunctorLayer
  6. abstract def restore[A](state: State[A]): M[A]

    Permalink
  7. abstract def zero[A](state: State[A]): Boolean

    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 clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  12. def layerImapK[A](ma: M[A])(forward: ~>[Inner, Inner], backward: ~>[Inner, Inner]): M[A]

    Permalink
    Definition Classes
    FunctorLayerFunctorFunctorLayer
  13. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

Inherited from MonadLayerFunctor[M, Inner]

Inherited from ApplicativeLayerFunctor[M, Inner]

Inherited from FunctorLayerFunctor[M, Inner]

Inherited from MonadLayer[M, Inner]

Inherited from ApplicativeLayer[M, Inner]

Inherited from FunctorLayer[M, Inner]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped