Configuration

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

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.

Value parameters

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.

Attributes

Companion
object
Source
Configuration.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list