Packages

trait ContextShift[F[_]] extends AnyRef

ContextShift provides support for shifting execution.

The shift method inserts an asynchronous boundary, which moves execution from the calling thread to the default execution environment of F.

The evalOn method provides a way to evaluate a task on a specific execution context, shifting back to the default execution context after the task completes.

This is NOT a type class, as it does not have the coherence requirement.

Annotations
@implicitNotFound("""Cannot find an implicit value for ContextShift[${F}]:
* import ContextShift[${F}] from your effects library
* if using IO, use cats.effect.IOApp or build one with cats.effect.IO.contextShift
"""
)
Source
ContextShift.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContextShift
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def evalOn[A](ec: ExecutionContext)(fa: F[A]): F[A]

    Evaluates fa on the supplied execution context and shifts evaluation back to the default execution environment of F at the completion of fa, regardless of success or failure.

    Evaluates fa on the supplied execution context and shifts evaluation back to the default execution environment of F at the completion of fa, regardless of success or failure.

    The primary use case for this method is executing code on a specific execution context. To execute blocking code, consider using the blockOn(blocker) method instead.

    ec

    Execution context where the evaluation has to be scheduled

    fa

    Computation to evaluate using ec

  2. abstract def shift: F[Unit]

    Asynchronous boundary described as an effectful F[_] that can be used in flatMap chains to "shift" the continuation of the run-loop to another thread or call stack.

    Asynchronous boundary described as an effectful F[_] that can be used in flatMap chains to "shift" the continuation of the run-loop to another thread or call stack.

    This is the Async.shift operation, without the need for an ExecutionContext taken as a parameter.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def blockOn[A](blocker: Blocker)(fa: F[A]): F[A]

    Evaluates fa on the supplied blocker and shifts evaluation back to the default execution environment of F at the completion of fa, regardless of success or failure.

    Evaluates fa on the supplied blocker and shifts evaluation back to the default execution environment of F at the completion of fa, regardless of success or failure.

    The primary use case for this method is executing blocking code on a dedicated execution context.

    blocker

    blocker where the evaluation has to be scheduled

    fa

    Computation to evaluate using blocker

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped