Modules

The following sections describe the additional modules.

Circe

The ciris-circe module provides ConfigDecoders for JSON using Circe.

import ciris.circe._
import ciris.ConfigDecoder
import io.circe.{Decoder, Json}

ConfigDecoder[String, Json]
// res0: ConfigDecoder[String, Json] = ConfigDecoder$2321399

case class SerialNumber(value: String)

object SerialNumber {
  implicit val serialNumberDecoder: Decoder[SerialNumber] =
    Decoder[String].map(apply)
}

circeConfigDecoder[SerialNumber]("SerialNumber")
// res1: ConfigDecoder[String, SerialNumber] = ConfigDecoder$334358184

Enumeratum

The ciris-enumeratum module provides ConfigDecoders for Enumeratum enumerations.

For regular Enums, also mix in CirisEnum to derive a ConfigDecoder instance.

import enumeratum.{CirisEnum, Enum, EnumEntry}
import enumeratum.EnumEntry.Lowercase

sealed trait Suit extends EnumEntry with Lowercase

object Suit extends Enum[Suit] with CirisEnum[Suit] {
  case object Clubs extends Suit
  case object Diamonds extends Suit
  case object Hearts extends Suit
  case object Spades extends Suit

  val values = findValues
}

ConfigDecoder[String, Suit]
// res2: ConfigDecoder[String, Suit] = ConfigDecoder$1096649609

For ValueEnums, also mix in the matching CirisValueEnum to derive a ConfigDecoder instance.

import enumeratum.values.{StringCirisEnum, StringEnum, StringEnumEntry}

sealed abstract class Color(val value: String) extends StringEnumEntry

object Color extends StringEnum[Color] with StringCirisEnum[Color] {
  case object Red extends Color("red")
  case object Green extends Color("green")
  case object Blue extends Color("blue")

  val values = findValues
}

ConfigDecoder[String, Color]
// res3: ConfigDecoder[String, Color] = ConfigDecoder$648876680

Refined

The ciris-refined module provides ConfigDecoders for refined refinement types.

import ciris.refined._
import cats.implicits._
import eu.timepit.refined.types.numeric.PosInt

ConfigDecoder[String, PosInt]
// res4: ConfigDecoder[String, PosInt] = ConfigDecoder$1028303225

Squants

The ciris-squants module provides ConfigDecoders for squants quantities.

import ciris.squants._
import squants.market.Money

ConfigDecoder[String, Money]
// res5: ConfigDecoder[String, Money] = ConfigDecoder$1106170078
← Configurations