Trait

enumeratum

CirceEnum

Related Doc: package enumeratum

Permalink

trait CirceEnum[A <: EnumEntry] extends AnyRef

Helper trait that adds implicit Circe encoders and decoders for an Enum's members

Example:

scala> import enumeratum._
scala> import cats.syntax.either._
scala> import io.circe._
scala> import io.circe.syntax._

scala> sealed trait ShirtSize extends EnumEntry
scala> case object ShirtSize extends Enum[ShirtSize] with CirceEnum[ShirtSize] {
     |  case object Small  extends ShirtSize
     |  case object Medium extends ShirtSize
     |  case object Large  extends ShirtSize
     |  val values = findValues
     | }

scala> val size: ShirtSize = ShirtSize.Small

scala> size.asJson
res0: Json = "Small"

scala> Json.fromString("Large").as[ShirtSize]
res1: Decoder.Result[ShirtSize] = Right(Large)


scala> Json.fromString("XLarge").as[ShirtSize]
res2: Decoder.Result[ShirtSize] = Left(DecodingFailure('XLarge' is not a member of enum ShirtSize, List()))
Self Type
CirceEnum[A] with Enum[A]
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CirceEnum
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. implicit val circeDecoder: Decoder[A]

    Permalink

    Implicit Decoder for this enum

  6. implicit val circeEncoder: Encoder[A]

    Permalink

    Implicit Encoder for this enum

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped