case classCodecMakerConfig(fieldNameMapper: (String) ⇒ String = identity, adtLeafClassNameMapper: (String) ⇒ String = JsonCodecMaker.simpleClassName, discriminatorFieldName: Option[String] = Some("type"), isStringified: Boolean = false, skipUnexpectedFields: Boolean = true, bitSetValueLimit: Int = 1024, bigDecimalScaleLimit: Int = 300) extends Product with Serializable
Configuration parameter for JsonCodecMaker.make() call.
Configuration parameter for JsonCodecMaker.make() call.
BEWARE: fieldNameMapper and adtLeafClassNameMapper functions should not depend on code from the same
compilation module where the make macro is called. Use a separated submodule of the project to compile all such
dependencies before their usage for generation of codecs.
Examples of functions that have no dependencies in the same compilation module are:
JsonCodecMaker.enforceCamelCase, JsonCodecMaker.enforce_snake_case, JsonCodecMaker.enforce-kebab-case, and
JsonCodecMaker.simpleClassName. Or their composition like:
s => JsonCodecMaker.enforce_snake_case(JsonCodecMaker.simpleClassName(s))
fieldNameMapper
the function of mapping from string of case class field name to JSON key (an identity
function by default)
adtLeafClassNameMapper
the function of mapping from string of case class/object full name to string value of
discriminator field (a function that truncate to simple class name by default)
discriminatorFieldName
an optional name of discriminator field, where None can be used for alternative
representation of ADTs without the discriminator field (Some("type") value by default)
isStringified
a flag that turn on stringification of number or boolean values of collections, options and
value classes (turned off by default)
skipUnexpectedFields
a flag that turn on skipping of unexpected fields or in other case a parse exception
will be thrown (turned on by default)
bitSetValueLimit
an exclusive limit for accepted numeric values in bit sets (1024 by default)
bigDecimalScaleLimit
an exclusive limit for accepted scale of 'BigDecimal' values (300 by default)
final classnamed extends Annotation with StaticAnnotation
Annotations
@field()
final classstringified extends Annotation with StaticAnnotation
Annotations
@field()
final classtransient extends Annotation with StaticAnnotation
Configuration parameter for
JsonCodecMaker.make()call.BEWARE:
fieldNameMapperandadtLeafClassNameMapperfunctions should not depend on code from the same compilation module where themakemacro is called. Use a separated submodule of the project to compile all such dependencies before their usage for generation of codecs.Examples of functions that have no dependencies in the same compilation module are:
JsonCodecMaker.enforceCamelCase,JsonCodecMaker.enforce_snake_case,JsonCodecMaker.enforce-kebab-case, andJsonCodecMaker.simpleClassName. Or their composition like:s => JsonCodecMaker.enforce_snake_case(JsonCodecMaker.simpleClassName(s))the function of mapping from string of case class field name to JSON key (an identity function by default)
the function of mapping from string of case class/object full name to string value of discriminator field (a function that truncate to simple class name by default)
an optional name of discriminator field, where None can be used for alternative representation of ADTs without the discriminator field (Some("type") value by default)
a flag that turn on stringification of number or boolean values of collections, options and value classes (turned off by default)
a flag that turn on skipping of unexpected fields or in other case a parse exception will be thrown (turned on by default)
an exclusive limit for accepted numeric values in bit sets (1024 by default)
an exclusive limit for accepted scale of 'BigDecimal' values (300 by default)