p

tofu

package tofu

Linear Supertypes
KernelTypes, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. tofu
  2. KernelTypes
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package alias
  2. package bi
  3. package common
  4. package compat
  5. package concurrent
  6. package config
  7. package control
  8. package data
  9. package doobie
  10. package env
  11. package fs2
  12. package fs2Instances
  13. package fs2Syntax
  14. package generate
  15. package higherKind
  16. package instances
  17. package internal
  18. package interop
  19. package kernel
  20. package lift
  21. package memo
  22. package observable
  23. package streams
  24. package syntax
  25. package time

Type Members

  1. type AnyK[_] = Any
    Definition Classes
    KernelTypes
  2. type ApplicativeThrow[F[_]] = ApplicativeError[F, Throwable]
    Definition Classes
    KernelTypes
  3. type BlockExec[F[_]] = ScopedExecute[Blocking, F]
    Definition Classes
    KernelTypes
  4. final type Blocks[F[_]] = Scoped[Blocking, F]
    Definition Classes
    KernelTypes
  5. trait BoundedParallel[F[_]] extends AnyRef
  6. type BracketThrow[F[_]] = Bracket[F, Throwable]
  7. type CalcExec[F[_]] = ScopedExecute[Calculation, F]
    Definition Classes
    KernelTypes
  8. type Calculates[F[_]] = Scoped[Calculation, F]
    Definition Classes
    KernelTypes
  9. type Catches[F[_]] = Handle[F, Throwable]
    Definition Classes
    KernelTypes
  10. class CatsDelay extends CatsDelayCE2
  11. class CatsDelayCE2 extends AnyRef
  12. trait Delay[F[_]] extends AnyRef
  13. trait ErrorBase extends AnyRef

    Base trait for instance search

  14. trait Errors[F[_], E] extends Raise[F, E] with Handle[F, E] with ErrorsTo[F, F, E]

    Allows to throw and handle errors of type ${E} in a ${F}.

    Allows to throw and handle errors of type ${E} in a ${F}.

    Annotations
    @implicitNotFound()
  15. class ErrorsBaseInstances extends ErrorsBaseInstances1
  16. class ErrorsBaseInstances1 extends ErrorsBaseInstances2
  17. class ErrorsBaseInstances2 extends ErrorsBaseInstances3
  18. class ErrorsBaseInstances3 extends AnyRef
  19. trait ErrorsTo[F[_], G[_], E] extends Raise[F, E] with HandleTo[F, G, E]

    Allows to throw and handle errors of type ${E} in a ${F} transiting to a ${G} when recovering.

    Allows to throw and handle errors of type ${E} in a ${F} transiting to a ${G} when recovering. A G can either be the same as F or some "subconstructor" having less errors semantically.

    Annotations
    @implicitNotFound()
  20. type Execute[F[_]] = ScopedExecute[Main, F]
    Definition Classes
    KernelTypes
  21. trait Fibers[F[_], Exit[_], Fib[_]] extends Race[F]
  22. trait Finally[F[_], Exit[_]] extends Guarantee[F]

    Bracket-like typeclass allowing to match exit of the process

    Bracket-like typeclass allowing to match exit of the process

    F

    effect process

    Exit

    structure, describing process exit like ExitCase or Exit

  23. trait Fire[F[_]] extends AnyRef
  24. trait Guarantee[F[_]] extends AnyRef

    Bracket-like typeclass allowing to understand if operation was succeed

    Bracket-like typeclass allowing to understand if operation was succeed

    F

    effect process

  25. trait Handle[F[_], E] extends HandleTo[F, F, E] with Restore[F]

    Allows to recover after an error of type ${E} in a ${F}.

    Allows to recover after an error of type ${E} in a ${F}.

    Annotations
    @implicitNotFound()
  26. trait HandleTo[F[_], G[_], E] extends RestoreTo[F, G]

    Allows to recover after an error of type ${E} in a ${F} transiting to a ${G} as a result.

    Allows to recover after an error of type ${E} in a ${F} transiting to a ${G} as a result. A G can either be the same as a F or some "subconstructor" having less errors semantically.

    Annotations
    @implicitNotFound()
  27. type In[C, F[_]] = WithContext[F, C]
    Definition Classes
    KernelTypes
  28. trait Init[F[_], A] extends AnyRef

    Initialize value of type A in type F

    Initialize value of type A in type F

    F

    initialization effect type

    A

    result type

  29. type IorC[C[_], E, A] = Ior[C[E], C[A]]
  30. type MonadThrow[F[_]] = MonadError[F, Throwable]
    Definition Classes
    KernelTypes
  31. type Perform[F[_], E] = PerformVia[F, [β$0$](Exit[E, β$0$]) => Unit, Unit]
    Definition Classes
    KernelTypes
  32. type PerformCont[Ex[_], A] = (Ex[A]) => Unit
    Definition Classes
    KernelTypes
  33. type PerformExitCont[E, A] = (Exit[E, A]) => Unit
    Definition Classes
    KernelTypes
  34. class PerformInterop extends PerformInterop1
  35. class PerformInterop1 extends PerformInterop2
  36. class PerformInterop2 extends AnyRef
  37. type PerformOf[F[_], Ex[_]] = PerformVia[F, [β$0$](Ex[β$0$]) => Unit, Unit]
    Definition Classes
    KernelTypes
  38. type PerformThrow[F[_]] = PerformVia[F, [β$0$](Exit[Throwable, β$0$]) => Unit, Unit]
    Definition Classes
    KernelTypes
  39. trait PerformVia[F[_], Cont[_], Cancel] extends WithContext[F, Performer[F, Cont, Cancel]]
    Annotations
    @implicitNotFound()
  40. trait Performer[F[_], -Cont[_], Cancel] extends AnyRef
  41. trait Pull[F[_], A] extends AnyRef

    simply F[A] in a typeclass form

  42. trait PullInstances extends AnyRef
  43. trait Push[F[_], A] extends AnyRef

    simply function A => F[Unit] in a typeclass form

  44. trait PushInstances extends PushInstances1
  45. trait PushInstances1 extends AnyRef
  46. trait Race[F[_]] extends Fire[F]
  47. trait Raise[F[_], E] extends ErrorBase with ContravariantRaise[F, E]

    Allows to raise E inside type F.

    Allows to raise E inside type F.

    Annotations
    @implicitNotFound()
  48. trait Restore[F[_]] extends RestoreTo[F, F]

    Allows to recover after some error in a ${F}.

    Allows to recover after some error in a ${F}.

    Annotations
    @implicitNotFound()
  49. trait RestoreTo[F[_], G[_]] extends Lift[G, F] with ErrorBase

    Allows to recover after some error in a ${F} transiting to a ${G} as a result.

    Allows to recover after some error in a ${F} transiting to a ${G} as a result. A G can either be the same as a F or some "subconstructor" having less errors semantically.

    Annotations
    @implicitNotFound()
  50. trait Scoped[Tag, F[_]] extends AnyRef

    can be used for scoped transformations

    can be used for scoped transformations

    Tag

    arbitrary type tag f type Execute[F[_]] = ScopedExecute[Scoped.Main, F] type Blocks[F[_]] = Scoped[Scoped.Blocking, F] type BlockExec[F[_]] = ScopedExecute[Scoped.Blocking, F] type Calculates[F[_]] = Scoped[Scoped.Calculation, F] type CalcExec[F[_]] = ScopedExecute[Scoped.Calculation, F]or discriminating scopes

    F

    process type

  51. trait ScopedExecute[Tag, F[_]] extends Scoped[Tag, F]
  52. trait ScopedInstances extends ScopedInstances0
  53. type Start[F[_]] = Fibers[F, Id, [β$0$]Fiber[F, β$0$]]
  54. type TConst[A, B] = A
    Definition Classes
    KernelTypes
  55. type Throws[F[_]] = Raise[F, Throwable]
    Definition Classes
    KernelTypes
  56. type Timeout[F[_]] = tofu.time.Timeout[F]
  57. type Tries[F[_]] = Errors[F, Throwable]
    Definition Classes
    KernelTypes
  58. abstract final class Void extends AnyRef
  59. trait WithContext[F[_], C] extends Context[F]

    Synonym for Context with explicit C as Ctx for better type inference

    Synonym for Context with explicit C as Ctx for better type inference

    There is also a nice type alias:

     import tofu.In
    
    val fHasMyCtx: MyCtx In F = ???
  60. trait WithLocal[F[_], C] extends Local[F] with WithContext[F, C]

    Synonym for Local with explicit C as Ctx for better type inference

  61. trait WithProvide[F[_], G[_], C] extends Provide[F] with Lift[G, F]

    Synonym for Provide with explicit C as Ctx and G as Lower for better type inference

    Synonym for Provide with explicit C as Ctx and G as Lower for better type inference

    Can be seen as transformation F[*] = C => G[*]

  62. trait WithRun[F[_], G[_], C] extends WithProvide[F, G, C] with WithLocal[F, C] with RunContext[F] with Unlift[G, F]

    Synonym for both RunContext and Unlift with explicit C as Ctx and G as Lower for better type inference

    Synonym for both RunContext and Unlift with explicit C as Ctx and G as Lower for better type inference

    Can be seen as transformation F[*] = C => G[*]

Deprecated Type Members

  1. trait Context[F[_]] extends ContextBase

    Declares that F can provide value of type Ctx

    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.

    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))

  2. type HasContext[F[_], C] = Context[F] { type Ctx = C }
    Definition Classes
    KernelTypes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithContext instead

  3. type HasContextRun[F[_], G[_], C] = WithRun[F, G, C]
    Definition Classes
    KernelTypes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithRun instead

  4. type HasLocal[F[_], C] = Local[F] { type Ctx = C }
    Definition Classes
    KernelTypes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithLocal instead

  5. type HasProvide[F[_], G[_], C] = WithProvide[F, G, C]
    Definition Classes
    KernelTypes
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithProvide instead

  6. trait Local[F[_]] extends Context[F]

    Allows to run some computation with notion of altered context consider using WithLocal for better type inference

    Allows to run some computation with notion of altered context consider using WithLocal for better type inference

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

  7. trait Provide[F[_]] extends ContextBase

    Allows to evaluate contextual computation with some context

    Allows to evaluate contextual computation with some context

    The main use case for it is to obtain some context Lower[Ctx], and then to run another contextual computation F[A] that can use F[Ctx] inside.

    F

    context-aware effect e.g.ReaderT[Lower, Ctx, *]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

  8. trait RunContext[F[_]] extends Local[F] with Provide[F]

    Combination of Local and Provide

    Combination of Local and Provide

    F

    context-aware effect e.g.ReaderT[Lower, Ctx, *]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

Abstract Value Members

  1. abstract def getClass(): Class[_ <: AnyRef]
    Definition Classes
    Any

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. val Timeout: tofu.time.Timeout.type
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def equals(arg0: Any): Boolean
    Definition Classes
    Any
  7. def hashCode(): Int
    Definition Classes
    Any
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. def toString(): String
    Definition Classes
    Any
  10. object BlockExec extends EffectComp[BlockExec]
  11. object Blocks extends EffectComp[Blocks]
  12. object BoundedParallel extends BoundedParallelInstances0 with EffectComp[BoundedParallel]
  13. object CalcExec extends EffectComp[CalcExec]
  14. object Calculates extends EffectComp[Calculates]
  15. object Delay extends CatsDelay with EffectComp[Delay]
  16. object ErrorBase extends ErrorsBaseInstances
  17. object Errors extends DataEffectComp[Errors]
  18. object Execute extends EffectComp[Execute]
  19. object Fibers extends Effect3Comp[Fibers]
  20. object Finally extends Effect2Comp[Finally]
  21. object Fire extends EffectComp[Fire] with FireInstances0
  22. object Guarantee extends EffectComp[Guarantee] with GuaranteeInstances0
  23. object Handle extends DataEffectComp[Handle]
  24. object PerformOf extends Effect2Comp[PerformOf]
  25. object PerformThrow extends EffectComp[PerformThrow]
  26. object PerformVia extends PerformInterop
  27. object Performer
  28. object Pull extends PullInstances with DataEffectComp[Pull]
  29. object Push extends PushInstances with DataEffectComp[Push]
  30. object Race extends EffectComp[Race]
  31. object Raise extends DataEffectComp[Raise]
  32. object Scoped extends ScopedInstances
  33. object Start extends EffectComp[Start]
  34. object Void
  35. object WithContext

    Companion object for WithContext

  36. object WithLocal

    Companion object for WithLocal

  37. object WithProvide

    Companion object for WithProvide

  38. object WithRun

    Companion object for WithRun

Deprecated Value Members

  1. object Context

    Companion object for Context

    Companion object for Context

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

  2. object HasContext
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithContext instead

  3. object HasContextRun
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithRun instead

  4. object HasLocal
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithLocal instead

  5. object HasProvide
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Use WithProvide instead

  6. object Local
    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

  7. object Provide

    Companion object for Provide

    Companion object for Provide

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

  8. object RunContext

    Companion object for RunContext

    Companion object for RunContext

    Annotations
    @deprecated
    Deprecated

    (Since version 0.10.3) Migrate to With* typeclasses

Inherited from KernelTypes

Inherited from AnyRef

Inherited from Any

Ungrouped