Packages

trait BiRun[F[+_, +_], G[+_, +_], X, C] extends BiLocal[F, X, C] with BiUnlift[G, F]

typeclass relation for running processes with provided environment

F

rich process type, that requires and has access the the environment

G

base process type

Linear Supertypes
BiUnlift[G, F], BiLift[G, F], BiLocal[F, X, C], BiContext[F, X, C], AnyRef, Any
Known Subclasses
BiRunEqvInstance, CalcBiContextInstance
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BiRun
  2. BiUnlift
  3. BiLift
  4. BiLocal
  5. BiContext
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def bifunctor: Bind[F]

    base F bifunctor inclusion

    base F bifunctor inclusion

    Definition Classes
    BiRun → BiUnlift → BiLift → BiContext
  2. abstract def context: F[X, C]

    read the contextual value of type C producing declared contextual error of type X

    read the contextual value of type C producing declared contextual error of type X

    Definition Classes
    BiContext
  3. abstract def lift[E, A](fa: G[E, A]): F[E, A]
    Definition Classes
    BiLift
  4. abstract def runLeft[E, A](fa: F[E, A])(x: X): G[E, A]

    run a process starting from the error state for the environment

    run a process starting from the error state for the environment

    fa

    a process to run

    x

    environmental error

    returns

    base process with provided environment

  5. abstract def runRight[E, A](fa: F[E, A])(c: C): G[E, A]

    run a process starting from the success state for the environment

    run a process starting from the success state for the environment

    fa

    a process to run

    c

    environmental result

    returns

    base process with provided environment

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 bilocal[E, A](fea: F[E, A])(lproj: (X) ⇒ X, rproj: (C) ⇒ C): F[E, A]

    run the process in a locally modified environment

    run the process in a locally modified environment

    fea

    process to run

    lproj

    a modification of the error part

    rproj

    a modification of the result part

    returns

    process with the same semantics as fea but run in the modified environment

    Definition Classes
    BiRun → BiLocal
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def disclose[E, A](k: (FunBK[F, G]) ⇒ F[E, A]): F[E, A]
    Definition Classes
    BiRun → BiUnlift
  8. def discloseBase[E, A](k: (FunBK[F, G]) ⇒ G[E, A]): F[E, A]
    Definition Classes
    BiUnlift
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def errLocal[E, A](fea: F[E, A])(proj: (X) ⇒ X): F[E, A]

    same as bilocal but modify only the error part

    same as bilocal but modify only the error part

    Definition Classes
    BiLocal
  12. def extract[E, A](err: PExtract[X, Any, E, Nothing], res: PExtract[C, Any, A, Nothing]): BiContext[F, E, A]

    focus this context instance

    focus this context instance

    err

    error mapping in the optical form, this could be autogenerated tofu.optics.Contains

    res

    context mapping in the optical form, this could be autogenerated tofu.optics.Contains

    returns

    focused instance of context

    Definition Classes
    BiContext
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def imap[E, A](err: Equivalent[X, E], res: Equivalent[C, A]): BiRun[F, G, E, A]

    map this environment using provided equivalences to other types

    map this environment using provided equivalences to other types

    err

    an optic for mapping context error

    res

    an optic for mapping context result

    returns

    focused instance

  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lextraxt[A](ex: PExtract[C, Any, A, Nothing]): BiContext[F, X, A]

    focus this context changing only the error

    focus this context changing only the error

    ex

    error mapping in the optical form

    returns

    focused instance of context

    Definition Classes
    BiContext
  19. def liftF: FunBK[G, F]
    Definition Classes
    BiLift
  20. def local[E, A](fea: F[E, A])(proj: (C) ⇒ C): F[E, A]

    same as bilocal but modify only the result part

    same as bilocal but modify only the result part

    Definition Classes
    BiLocal
  21. def lsub[E](cts: Contains[X, E]): BiLocal[F, E, C]

    same as sub but focus on the error only

    same as sub but focus on the error only

    Definition Classes
    BiLocal
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def rextract[E](ex: PExtract[X, Any, E, Nothing]): BiContext[F, E, C]

    focus this context changing only the result

    focus this context changing only the result

    ex

    error mapping in the optical for

    returns

    focused instance of context

    Definition Classes
    BiContext
  26. def rsub[A](cts: Contains[C, A]): BiLocal[F, X, A]

    same as sub but focus on the result only

    same as sub but focus on the result only

    Definition Classes
    BiLocal
  27. def runEither[E, A](fa: F[E, A])(ctx: Either[X, C]): G[E, A]

    run a process starting the environment from the state defined by disjuction

    run a process starting the environment from the state defined by disjuction

    fa

    a process to run

    ctx

    environment

    returns

    base process with provided environment

  28. def runEitherK(ctx: Either[X, C]): FunBK[F, G]
  29. def runLeftK(x: X): FunBK[F, G]
  30. def runRightK(c: C): FunBK[F, G]
  31. def sub[E, A](err: Contains[X, E], res: Contains[C, A]): BiLocal[F, E, A]

    focus this context instance this will read and modify only the given parts of the context

    focus this context instance this will read and modify only the given parts of the context

    err

    an optic for reading from and updating a larger context error

    res

    an optic for reading from and updating a larget context result

    returns

    focused instance

    Definition Classes
    BiLocal
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def unlift[E]: F[E, FunBK[F, G]]
    Definition Classes
    BiUnlift
  35. def unliftErr[A]: F[FunBK[F, G], A]
    Definition Classes
    BiUnlift
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from BiUnlift[G, F]

Inherited from BiLift[G, F]

Inherited from BiLocal[F, X, C]

Inherited from BiContext[F, X, C]

Inherited from AnyRef

Inherited from Any

Ungrouped