Configuration

io.circe.derivation.Configuration
See theConfiguration companion object
case class Configuration(transformMemberNames: String => String, transformConstructorNames: String => String, useDefaults: Boolean, discriminator: Option[String], strictDecoding: Boolean)

Configuration allowing customization of the JSON produced when encoding, or expected when decoding.

Attributes

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.

strictDecoding

Whether to fail when superfluous fields are found.

transformConstructorNames

Transforms the value of any constructor names in the JSON allowing, for example, formatting or case changes.

transformMemberNames

Transforms the names of any case class members in the JSON allowing, for example, formatting or case changes.

useDefaults

Whether to allow default values as specified for any case-class members.

Companion:
object
Source:
Configuration.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product