Enumeratum module

kantan.regex comes with an enumeratum module that can be used by adding the following dependency to your build.sbt:

libraryDependencies += "com.nrinaudo" %% "kantan.regex-enumeratum" % "0.5.3"

Name-based enumerations

When working with enumerations of type Enum, you should import the following package:

import kantan.regex.enumeratum._

And that’s pretty much it. You can now encode and decode your enumeration directly.

Let’s first set our types up:

import enumeratum._

sealed trait DummyEnum extends EnumEntry

object DummyEnum extends Enum[DummyEnum] {

  val values = findValues

  case object Hello   extends DummyEnum
  case object GoodBye extends DummyEnum
  case object Hi      extends DummyEnum

}

And a few further imports, to bring our enumeration and the kantan.csv syntax in scope:

import kantan.regex.implicits._

We can then simply write the following:

"[Hello]".evalRegex[DummyEnum](rx"\[([a-zA-Z]+)]", 1).toList
// res0: List[kantan.regex.package.DecodeResult[DummyEnum]] = List(
//   Right(value = Hello)
// )

"[GoodDay]".evalRegex[DummyEnum](rx"\[([a-zA-Z]+)]", 1).toList
// res1: List[kantan.regex.package.DecodeResult[DummyEnum]] = List(
//   Left(
//     value = TypeError(
//       message = "'GoodDay' is not a member of enumeration [Hello, GoodBye, Hi]"
//     )
//   )
// )

Value-based enumerations

For enumerations of type ValueEnum, you should import the following package:

import kantan.regex.enumeratum.values._

And that’s pretty much it. You can now encode and decode your enumeration directly.

Let’s first set our types up:

import enumeratum.values._

sealed abstract class Greeting(val value: Int) extends IntEnumEntry

object Greeting extends IntEnum[Greeting] {

  val values = findValues

  case object Hello   extends Greeting(1)
  case object GoodBye extends Greeting(2)
  case object Hi      extends Greeting(3)
  case object Bye     extends Greeting(4)

}

And a few further imports, to bring our enumeration and the kantan.csv syntax in scope:

import kantan.regex.implicits._

We can then simply write the following:

"[1]".evalRegex[Greeting](rx"\[([+-]?\d+)\]", 1).toList
// res3: List[kantan.regex.package.DecodeResult[Greeting]] = List(
//   Right(value = Hello)
// )

"[-2]".evalRegex[Greeting](rx"\[([+-]?\d+)\]", 1).toList
// res4: List[kantan.regex.package.DecodeResult[Greeting]] = List(
//   Left(value = TypeError(message = "'-2' is not in values [1, 2, 3, 4]"))
// )
Other tutorials: