Trait/Object

cats.effect

ContextShift

Related Docs: object ContextShift | package effect

Permalink

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( ... )
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. All

Abstract Value Members

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

    Permalink

    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 blocking code on a dedicated execution context.

    ec

    Execution context where the evaluation has to be scheduled

    fa

    Computation to evaluate using ec

  2. abstract def shift: F[Unit]

    Permalink

    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

    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. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped