Settings

Before configuring settings here it is useful to understand how converter generation works and how to configure nested settings.

Conversion

These settings can only be defined as CLI argument or conversion comment.

• converter marker comment for conversion interfaces
• enum [yes|no] enable / disable enum support
• enum:exclude [PACKAGE:]NAME exclude wrongly detected enums
• extend [PACKAGE:]FUNC... add custom functions for conversions
• name NAME rename generated struct
• output:file FILE set the output directory for a converter
• output:format FORMAT set the output format
• output:package [PACKAGE:]NAME set the output package for a converter
• output:raw CODE add raw code to generated output
• struct:comment COMMENT add comments to generated struct
• variables marker comment for variable blocks

Method

These settings can only be defined as method comment.

• autoMap PATH automatically match fields from a sub struct to the target struct
• context ARG define an argument as context
• default [PACKAGE:]FUNC define default target value
• enum:map SOURCE TARGET define an enum value mapping
• enum:transform ID CONFIG use an enum value transformer
• ignore FIELD... ignore fields for a struct
• map [SOURCE-PATH] TARGET [| FUNC] struct mappings
  • map SOURCE-FIELD TARGET define a field mapping
  • map SOURCE-PATH TARGET define a nested field mapping
  • map . TARGET map the source type to the target field
  • map [SOURCE-PATH] TARGET| FUNC map the SOURCE-PATH to the TARGET field by using FUNC
• update ARG update fields on ARG

Method (inheritable)

These settings can be defined as CLI argument, conversion comment or method comment and are inheritable.

• arg:context:regex REGEX set context param regex
• enum:unknown ACTION|KEY handle unexpected enum values
• ignoreMissing [yes,no] ignore missing struct fields
• ignoreUnexported [yes,no] ignore unexported struct fields
• matchIgnoreCase [yes,no] case-insensitive field matching
• skipCopySameType [yes,no] skip copying types when the source and target type are the same
• update:ignoreZeroValueField [yes:no] don't update fields with zero values
• useUnderlyingTypeMethods [yes|no] use underlying types when looking for existing methods
• useZeroValueOnPointerInconsistency [yes|no] Use zero values for *S to T conversions
• wrapErrorsUsing [PACKAGE] wrap errors using a custom implementation
• wrapErrors [yes,no] wrap errors with extra information

Custom Function

These settings can only be defined as custom function comment.

• context ARG define an argument as context