Cats MTL interop

Interop with cats MTL library

Obviously, this is a module inside TOFU for interop between some Cats MTL typeclasses and tofu-kernel

For example, you have an external code using Cats MTL like this:

import cats.mtl.Ask
import cats.Functor
import cats.syntax.functor._

def externalProgram[F[_]: Functor](m: Int, f: String => String)(implicit A: Ask[F, String]): F[String] = {
for {
  ctx <- A.ask
  res = f(ctx)
} yield res * m
}

and your code using TOFU where you have different context typeclasses:

import cats.effect.Sync
import cats.syntax.functor._
import cats.syntax.flatMap._
import tofu.WithContext

import scala.util.Random

def yourProgram[F[_]: Sync: WithContext[*[_], String]]: F[String] = {
for {
  int <- Sync[F].delay(scala.util.Random.nextInt())
  result <- externalProgram[F](int, identity)
} yield result
}

so you have a problem - how we can easily use extermalProblem? Usually programmers write your own implicit conversions, but TOFU could provide this instance for you!

Install

For installation interop, add dependency into your project:

This library provides three modules with conversions: import it into your code files:

From Cats MTL instances to TOFU instances: import tofu.kernel.interop.catsmtl.tofuimplicits._
From TOFU instances to Cats MTL instances: import tofu.kernel.interop.catsmtl.mtlimplicits._
Explicit conversions between Cats MTL and TOFU instances: import tofu.kernel.interop.catsmtl.instances._

Conversions

In this module we provide some conversions to Cats MTL typeclasses from TOFU typeclasses:

[F[_], C] (WithContext[F, C], Applicative[F]) => Ask[F, C]
[F[_], C] (WithLocal[F, C], Applicative[F], ) => Local[F, C]
[F[_], E] (Raise[F, E], Functor[F]) => Raise[F, E]
[F[_], E] (Errors[F, E], Applicative[F]) => Handle[F, E]

Also, we provide conversions to TOFU typeclasses from Cats MTL typeclasses:

[F[_], C] (Ask[F, C]) => WithContext[F, C]
[F[_], C] (Local[F, C]) => WithLocal[F, C]
[F[_], E] (Raise[F, E]) => Raise[F, E]
[F[_], E] (Handle[F, E]) => Errors[F, E]