Modules Overview

The following modules integrate with external libraries to provide extended functionality.
You might also be interested in the third-party external libraries which integrate with Ciris.

The cats module enables use of cats type class instances.

import cats.implicits._
import ciris.cats._
import ciris.envF
import scala.concurrent._

implicit val executionContext: ExecutionContext =
  ExecutionContext.Implicits.global

envF[Future, Boolean]("CI")

The cats-effect module enables use of cats-effect effect types and type class instances.

import cats.effect.IO
import ciris.cats.effect._
import ciris.fileSync

fileSync[IO, Int](tempFile, _.trim)

The enumeratum module enables decoding of enumeratum enumerations.

object environments {
  import enumeratum._

  sealed abstract class AppEnvironment extends EnumEntry

  object AppEnvironment extends Enum[AppEnvironment] {
    case object Local extends AppEnvironment
    case object Testing extends AppEnvironment
    case object Production extends AppEnvironment

    val values = findValues
  }
}

import ciris.enumeratum._
import ciris.env
import environments._

env[AppEnvironment]("APP_ENV")

The generic module enables generic decoding of product and coproduct types using shapeless.

import ciris.generic._
import ciris.prop

final case class Decibel(val value: Int) extends AnyVal

prop[Decibel]("ratio.delta")

The refined module enables decoding of refined refinement types.

import ciris.refined._
import eu.timepit.refined.types.net.UserPortNumber

env[Option[UserPortNumber]]("HTTP_PORT")

The spire module enables decoding of spire number types.

import ciris.spire._
import spire.math.Natural

env[Natural]("DELAY_SECONDS")

The squants module enables decoding of squants quantities with unit of measure.

import ciris.squants._
import squants.time.Time

prop[Time]("refresh.interval")