Packages

p

enumeratum

package enumeratum

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package values

Type Members

  1. trait CirceEnum[A <: EnumEntry] extends AnyRef

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

    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()))
  2. trait CirceKeyEnum[A <: EnumEntry] extends AnyRef

    Helper trait that adds implicit Circe KeyEncoder/KeyDecoder for an Enum 's members.

Value Members

  1. object Circe

    Created by Lloyd on 4/14/16.

    Created by Lloyd on 4/14/16.

    Copyright 2016

Ungrouped