trait Context[F[_]] extends ContextBase

Declares that F can provide value of type Ctx

In other words this trait tells you that F is some kind of Reader or function of type Ctx => F[A]. The best way to use it is through WithContext or In

This can be seen as global value for your Application or for a part of it.

Self Type
Context[F]
Annotations
@deprecated
Deprecated

(Since version 0.10.3) Migrate to With* typeclasses

Example:

  1. One common use of this is to make contextual logging:

      import tofu.syntax.console._

def contexualConsolling[F[_]: Console: FlatMap](message: String)(implicit hasMyCtx: F HasContext MyCtx): F[Unit] =
  hasMyCtx.askF(ctx => puts"$message (Also context: $ctx)")

    so when you have MyCtx(3) the call of contextualConsolling("Hi!") prints Hi! (Also MyCtx(3))

Linear Supertypes
ContextBase, AnyRef, Any
Known Subclasses
PerformVia, WithContext, WithLocal, WithRun, CalcContextInstance, PerformCarrier2, PerformCarrier2Context, PerformCarrier3, PerformOfMappedPerformer, PerformViaMappedPerformer, PerformViaReader, PerformViaUnlift, Local, RunContext
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Context
  2. ContextBase
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Ctx

Abstract Value Members

  1. abstract def context: F[Ctx]
  2. abstract def functor: Functor[F]

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 ask[A](f: (Ctx) => A): F[A]

    Returns context modified by pure function f.

    Returns context modified by pure function f.

    For example one can use it like that:

    Context[F].ask(myCtx => myCtx.toString)

    Also there is more convenient syntax:

    import tofu.syntax.context._

ask[F](myCtx => myCtx.toString)
    Note

    It does not affect context itself.

  6. def askF[A](f: (Ctx) => F[A])(implicit F: FlatMap[F]): F[A]

    Same as ask but f is effectual

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def extract[A](extract: Extract[Ctx, A]): WithContext[F, A]

    Allows to focus context on its inside with lens.

    Allows to focus context on its inside with lens.

    extract

    lens that can extract value of type A from Ctx

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  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()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from ContextBase

Inherited from AnyRef

Inherited from Any

Ungrouped