jsoniter-scala-macros
API
Generated with
jsoniter-scala-macros/com.github.plokhotnyuk.jsoniter_scala.macros/JsonCodecMaker

JsonCodecMaker

com.github.plokhotnyuk.jsoniter_scala.macros.JsonCodecMaker
object JsonCodecMaker

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

inline def make[A]: JsonValueCodec[A]

Derives a codec for JSON values for the specified type A.

Derives a codec for JSON values for the specified type A.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def make[A](inline config: CodecMakerConfig): JsonValueCodec[A]

Derives a codec for JSON values for the specified type A and a provided derivation configuration.

Derives a codec for JSON values for the specified type A and a provided derivation configuration.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Value parameters

config

a derivation configuration

Attributes

Returns

an instance of the derived codec

inline def makeCirceLike[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withTransientNone(false).withDiscriminatorFieldName(None) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withTransientNone(false).withDiscriminatorFieldName(None) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeCirceLikeSnakeCased[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withTransientNone(false).withDiscriminatorFieldName(None).withAdtLeafClassNameMapper(x => enforce_snake_case(simpleClassName(x))).withFieldNameMapper(enforce_snake_case).withJavaEnumValueNameMapper(enforce_snake_case) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withTransientNone(false).withDiscriminatorFieldName(None).withAdtLeafClassNameMapper(x => enforce_snake_case(simpleClassName(x))).withFieldNameMapper(enforce_snake_case).withJavaEnumValueNameMapper(enforce_snake_case) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeOpenapiLike[A]: JsonValueCodec[A]

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true)

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true)

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeOpenapiLike[A](discriminatorFieldName: String): JsonValueCodec[A]

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true) with a privided discriminator field name.

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true) with a privided discriminator field name.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Value parameters

discriminatorFieldName

a name of discriminator field

Attributes

Returns

an instance of the derived codec

inline def makeOpenapiLike[A](discriminatorFieldName: String, inline adtLeafClassNameMapper: PartialFunction[String, String]): JsonValueCodec[A]

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true) with a privided discriminator field name and an ADT leaf-class name mapper with sequentionally applied function that truncates to simple class name by default

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true) with a privided discriminator field name and an ADT leaf-class name mapper with sequentionally applied function that truncates to simple class name by default

Type parameters

A

a type that should be encoded and decoded by the derived codec

Value parameters

adtLeafClassNameMapper

the function of mapping from string of case class/object full name to string value of discriminator field

discriminatorFieldName

a name of discriminator field

Attributes

Returns

an instance of the derived codec

inline def makeOpenapiLikeWithoutDiscriminator[A]: JsonValueCodec[A]

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true).withDiscriminatorFieldName(scala.None))

Replacements for the make call preconfigured to behave as expected by openapi specifications: CodecMakerConfig.withTransientEmpty(false).withTransientDefault(false).withRequireCollectionFields(true).withAllowRecursiveTypes(true).withDiscriminatorFieldName(scala.None))

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeWithRequiredCollectionFields[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withRequireCollectionFields(true) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withRequireCollectionFields(true) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeWithRequiredCollectionFieldsAndNameAsDiscriminatorFieldName[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withRequireCollectionFields(true).withDiscriminatorFieldName(Some("name")) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withTransientEmpty(false).withRequireCollectionFields(true).withDiscriminatorFieldName(Some("name")) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeWithRequiredDefaultFields[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withTransientDefault(false).withRequireDefaultFields(true) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withTransientDefault(false).withRequireDefaultFields(true) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeWithSkipNestedOptionValues[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withSkipNestedOptionValues(true) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withSkipNestedOptionValues(true) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

inline def makeWithoutDiscriminator[A]: JsonValueCodec[A]

A replacement for the make call with the CodecMakerConfig.withDiscriminatorFieldName(None) configuration parameter.

A replacement for the make call with the CodecMakerConfig.withDiscriminatorFieldName(None) configuration parameter.

Type parameters

A

a type that should be encoded and decoded by the derived codec

Attributes

Returns

an instance of the derived codec

def simpleClassName(fullClassName: String): String

Mapping function for class names that should be trimmed to the simple class name without package prefix.

Mapping function for class names that should be trimmed to the simple class name without package prefix.

Value parameters

fullClassName

the name to transform

Attributes

Returns

a transformed name or the same name if no transformation is required

Concrete fields

val EnforcePascalCase: PartialFunction[String, String]

Mapping function for field or class names that should be in PascalCase format.

Mapping function for field or class names that should be in PascalCase format.

Attributes

Returns

a transformed name or the same name if no transformation is required

val enforce-kebab-case: PartialFunction[String, String]

Mapping function for field or class names that should be in kebab-case format with separated non-alphabetic characters.

Mapping function for field or class names that should be in kebab-case format with separated non-alphabetic characters.

Attributes

Returns

a transformed name or the same name if no transformation is required

val enforce-kebab-case2: PartialFunction[String, String]

Mapping function for field or class names that should be in kebab-case format with joined non-alphabetic characters.

Mapping function for field or class names that should be in kebab-case format with joined non-alphabetic characters.

Attributes

Returns

a transformed name or the same name if no transformation is required

val enforceCamelCase: PartialFunction[String, String]

Mapping function for field or class names that should be in camelCase format.

Mapping function for field or class names that should be in camelCase format.

Attributes

Returns

a transformed name or the same name if no transformation is required

val enforce_snake_case: PartialFunction[String, String]

Mapping function for field or class names that should be in snake_case format with separated non-alphabetic characters.

Mapping function for field or class names that should be in snake_case format with separated non-alphabetic characters.

Attributes

Returns

a transformed name or the same name if no transformation is required

val enforce_snake_case2: PartialFunction[String, String]

Mapping function for field or class names that should be in snake_case format with joined non-alphabetic characters.

Mapping function for field or class names that should be in snake_case format with joined non-alphabetic characters.

Attributes

Returns

a transformed name or the same name if no transformation is required

val partialIdentity: PartialFunction[String, String]

A partial function that is a total in fact and always returns a string passed to it.

A partial function that is a total in fact and always returns a string passed to it.

Attributes

Returns

a provided value

Generated with