structs

Documentation

Overview

Package structs provides functions for struct conversion.

Index

• func MapField(pointer interface{}, priority []string, recursive bool) map[string]*Field
• func TagMapField(pointer interface{}, priority []string, recursive bool) map[string]*Field
• func TagMapName(pointer interface{}, priority []string, recursive bool) map[string]string
• type Field
  • func TagFields(pointer interface{}, priority []string, recursive bool) []*Field

Functions

func MapField

func MapField(pointer interface{}, priority []string, recursive bool) map[string]*Field

MapField retrieves struct field as map[name/tag]*Field from <pointer>, and returns it.

The parameter <recursive> specifies whether retrieving the struct field recursively.

Note that it only retrieves the exported attributes with first letter up-case from struct.

func TagMapField

func TagMapField(pointer interface{}, priority []string, recursive bool) map[string]*Field

TagMapField retrieves struct tags as map[tag]*Field from <pointer>, and returns it.

The parameter <recursive> specifies whether retrieving the struct field recursively.

Note that it only retrieves the exported attributes with first letter up-case from struct.

func TagMapName

func TagMapName(pointer interface{}, priority []string, recursive bool) map[string]string

TagMapName retrieves struct tags as map[tag]attribute from <pointer>, and returns it.

The parameter <recursive> specifies whether retrieving the struct field recursively.

Note that it only retrieves the exported attributes with first letter up-case from struct.

Types

type Field

type Field struct {
	*structs.Field
	// Retrieved tag name. There might be more than one tags in the field,
	// but only one can be retrieved according to calling function rules.
	Tag string
}

Field is alias of structs.Field.

func TagFields

func TagFields(pointer interface{}, priority []string, recursive bool) []*Field

TagFields retrieves struct tags as []*Field from <pointer>, and returns it.

The parameter <recursive> specifies whether retrieving the struct field recursively.

Note that it only retrieves the exported attributes with first letter up-case from struct.