final case class CodecConfig(explicitEmptyCollections: ExplicitConfig = JsonCodec.ExplicitConfig(), explicitNulls: ExplicitConfig = JsonCodec.ExplicitConfig(), discriminatorSettings: DiscriminatorSetting = JsonCodec.DiscriminatorSetting.default, fieldNameFormat: NameFormat = NameFormat.Identity, treatStreamsAsArrays: Boolean = false, rejectExtraFields: Boolean = false) extends Product with Serializable
Configuration for the JSON codec. The configurations are overruled by the annotations that configure the same behavior.
- explicitEmptyCollections
whether to encode empty collections as
[]or omit the field and decode the field when it is missing as an empty collection or fail- explicitNulls
whether to encode empty Options as
nullor omit the field and decode the field when it is missing to None or fail- discriminatorSettings
set up how to handle discriminators
- fieldNameFormat
format for the field names
- treatStreamsAsArrays
whether to treat streams as arrays when encoding/decoding
- rejectExtraFields
whether to reject extra fields during decoding
- Alphabetic
- By Inheritance
- CodecConfig
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CodecConfig(explicitEmptyCollections: ExplicitConfig = JsonCodec.ExplicitConfig(), explicitNulls: ExplicitConfig = JsonCodec.ExplicitConfig(), discriminatorSettings: DiscriminatorSetting = JsonCodec.DiscriminatorSetting.default, fieldNameFormat: NameFormat = NameFormat.Identity, treatStreamsAsArrays: Boolean = false, rejectExtraFields: Boolean = false)
- explicitEmptyCollections
whether to encode empty collections as
[]or omit the field and decode the field when it is missing as an empty collection or fail- explicitNulls
whether to encode empty Options as
nullor omit the field and decode the field when it is missing to None or fail- discriminatorSettings
set up how to handle discriminators
- fieldNameFormat
format for the field names
- treatStreamsAsArrays
whether to treat streams as arrays when encoding/decoding
- rejectExtraFields
whether to reject extra fields during decoding
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val discriminatorSettings: DiscriminatorSetting
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val explicitEmptyCollections: ExplicitConfig
- val explicitNulls: ExplicitConfig
- val fieldNameFormat: NameFormat
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- val ignoreEmptyCollections: Boolean
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rejectExtraFields: Boolean
- def schemaConfig: Configuration
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val treatStreamsAsArrays: Boolean
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])