extras

Type Members

trait AutoDerivation extends AnyRef

Fully automatic configurable codec derivation.
Fully automatic configurable codec derivation.
Extending this trait provides io.circe.Decoder and io.circe.Encoder instances for case classes (if all members have instances), "incomplete" case classes, sealed trait hierarchies, etc.
class ConfigurableDeriver extends DerivationMacros[ReprDecoder, ReprObjectEncoder, ConfiguredDecoder, ConfiguredObjectEncoder]
final case class Configuration(transformMemberNames: (String) ⇒ String, transformConstructorNames: (String) ⇒ String, useDefaults: Boolean, discriminator: Option[String]) extends Product with Serializable

Configuration allowing customisation of the JSON produced when encoding, or expected when decoding.
Configuration allowing customisation of the JSON produced when encoding, or expected when decoding. Can be used with the ConfiguredJsonCodec annotation to allow customisation of the semi-automatic derivation.
transformMemberNames
Transforms the names of any case class members in the JSON allowing, for example, formatting or case changes.
transformConstructorNames
Transforms the value of any constructor names in the JSON allowing, for example, formatting or case changes.
useDefaults
Whether to allow default values as specified for any case-class members.
discriminator
Optional key name that, when given, will be used to store the name of the constructor of an ADT in a nested field with this name. If not given, the name is instead stored as a key under which the contents of the ADT are stored as an object.
macro class ConfiguredJsonCodec extends Annotation with StaticAnnotation

Annotations
@compileTimeOnly( ... )
final case class JsonKey(value: String) extends Annotation with StaticAnnotation with Product with Serializable

Value Members

object Configuration extends Serializable
package decoding
object defaults
package encoding
object semiauto

Semi-automatic codec derivation.
Semi-automatic codec derivation.
This object provides helpers for creating io.circe.Decoder and io.circe.ObjectEncoder instances for case classes, "incomplete" case classes, sealed trait hierarchies, etc.
Typical usage will look like the following:
```
import io.circe._, io.circe.generic.semiauto._

case class Foo(i: Int, p: (String, Double))

object Foo {
  implicit val decodeFoo: Decoder[Foo] = deriveDecoder[Foo]
  implicit val encodeFoo: ObjectEncoder[Foo] = deriveEncoder[Foo]
}
```
package util

package extras

Type Members

trait AutoDerivation extends AnyRef

class ConfigurableDeriver extends DerivationMacros[ReprDecoder, ReprObjectEncoder, ConfiguredDecoder, ConfiguredObjectEncoder]

final case class Configuration(transformMemberNames: (String) ⇒ String, transformConstructorNames: (String) ⇒ String, useDefaults: Boolean, discriminator: Option[String]) extends Product with Serializable

macro class ConfiguredJsonCodec extends Annotation with StaticAnnotation

final case class JsonKey(value: String) extends Annotation with StaticAnnotation with Product with Serializable

Value Members

object Configuration extends Serializable

package decoding

object defaults

package encoding

object semiauto

package util

Ungrouped