trait RunContext[F[_]] extends Local[F] with Provide[F]
- F
context-aware effect e.g.
ReaderT[Lower, Ctx, *]
- Annotations
- @deprecated
- Deprecated
(Since version 0.10.3) Migrate to With* typeclasses
- Alphabetic
- By Inheritance
- RunContext
- Provide
- Local
- Context
- ContextBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
Abstract Value Members
- abstract def context: F[Ctx]
- Definition Classes
- Context
- abstract def functor: Functor[F]
- Definition Classes
- Context
- abstract def lift[A](la: Lower[A]): F[A]
Converts context-unaware computation into contextual one by ignoring context
Converts context-unaware computation into contextual one by ignoring context
One can treat
F[A]as function of typeCtx => Lower[A]so this method creates something like_ => lawhich has typeCtx => Lower[A]- Definition Classes
- Provide
- abstract def local[A](fa: F[A])(project: (Ctx) => Ctx): F[A]
Alters context for computation
Alters context for computation
- fa
computation that is going to run with different context
- project
pure function
- returns
result of ran computation
fa
- Definition Classes
- Local
Example of usage is to hide sensitive information
case class UserContext( id: String, phoneNumber: String //very sensitive ) def hidePartOfPhoneNumber: String => String = ??? def contextualLogInfo[F[_]](message: String)(implicit hasUserContext: UserContext In F): F[Unit] = ??? //logs both message AND UserContext def program[F[_]: Monad] = for { user <- obtainUserSomehow[F] implicit0(hasUserContext: In[User, F]) <- Context.const[F, User](user.toContext) logUser = contextualLogInfo[F](s"Successfully obtained user") _ <- logUser.local(hidePartOfPhoneNumber) //logs only part of phone number } yield ()
Example: - abstract def runContext[A](fa: F[A])(ctx: Ctx): Lower[A]
Runs
faprovidingctxto it.Runs
faprovidingctxto it.One can treat F as function of type
Ctx => Lower[A]so this method applies it toctx.- fa
Contextual computation
- returns
Result of running fa and providing it context
- Definition Classes
- Provide
Example of usage is to hide sensitive information across a part of service
import tofu.syntax.context._ case class UserContext( id: String, phoneNumber: String //very sensitive ) def hidePartOfPhoneNumber: String => String = ??? def contextualLogInfo[F[_]](message: String)(implicit hasUserContext: UserContext In F): F[Unit] = ??? //logs both message AND UserContext def program[F[_]: WithRun[*[_], G[_], UserContext], G[_]: Monad] = for { user <- obtainUserSomehow[G] logUser = contextualLogInfo[F](s"Successfully obtained user") _ <- runContext[F](logUser)(user.toContext) //G[Unit] } yield ()
Example: - abstract def self: WithRun[F, Lower, Ctx]
- Definition Classes
- RunContext → Provide
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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)
- Definition Classes
- Context
- Note
It does not affect context itself.
- def askF[A](f: (Ctx) => F[A])(implicit F: FlatMap[F]): F[A]
Same as ask but
fis effectual - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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
AfromCtx
- Definition Classes
- Context
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def runContextK(ctx: Ctx): ~>[F, Lower]
Same as runContext but higher-kinded.
Same as runContext but higher-kinded.
- Definition Classes
- Provide
trait ProcessHandler[G[_]] { def mapK[M[_]](fk: G ~> M): ProcessHandler[M] = ??? //...other methods } type WithMyContext[F[_], A] = ReaderT[F, MyCtx, A] val contextualProcessHandler: ProcessHandler[IO WithMyContext *] = ??? val processHandler: ProcessHandler[IO] = processHandler.mapK( WithProvide[IO WithMyContext *, IO, MyCtx].runContextK )
Example: - def runEquivalent[A](eq: Equivalent[Ctx, A]): WithRun[F, Lower, A]
Allows to focus Provide on inner parts of its context with equivalence lens.
Allows to focus Provide on inner parts of its context with equivalence lens.
- eq
lens that can convert from
CtxtoA
- def runExtract[A](extract: Extract[A, Ctx]): WithProvide[F, Lower, A]
Allows to focus Provide on inner parts of its context with lens.
- def subcontext[A](contains: Contains[Ctx, A]): WithLocal[F, A]
Allows to focus Local on inner parts of its context with lens.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unlift: F[~>[F, Lower]]
Allows to convert some context-unaware computation into contextual one.
Allows to convert some context-unaware computation into contextual one.
trait ProcessHandler[G[_]] { def mapK[M[_]](fk: G ~> M): ProcessHandler[M] = ??? //...other methods } type WithMyContext[F[_], A] = ReaderT[F, MyCtx, A] val processHandler: ProcessHandler[IO WithMyContext *] = ??? val contextualHandler: IO WithMyContext ProcessHandler[IO] = processHandler.mapK( WithRun[WithMyContext[IO, *], IO, MyCtx].unlift.map(fk => processHandler.mapK(fk)) ) //now it is able to process MyCtx but is wrapped in IO WithMyContext *
Example: - final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated