comments

Documentation

Index

• type Converter
  • func ParseDocs(pattern string) ([]Converter, error)
• type ConverterConfig
• type Method
• type MethodMapping

Types

type Converter

type Converter struct {
	Name    string
	Config  ConverterConfig
	Methods MethodMapping
}

Converter defines a converter that was marked with converterMarker.

func ParseDocs

func ParseDocs(pattern string) ([]Converter, error)

ParseDocs parses the docs for the given pattern.

type ConverterConfig

type ConverterConfig struct {
	Name             string
	ExtendMethods    []string
	CaseInsensitive  bool
	IgnoreUnexported bool
}

ConverterConfig contains settings that can be set via comments.

type Method

type Method struct {
	IgnoredFields map[string]struct{}
	NameMapping   map[string]string
	// target to source
	IdentityMapping map[string]struct{}
}

Method contains settings that can be set via comments.

type MethodMapping

type MethodMapping map[string]Method

MethodMapping a mapping between method name and method.