gstructs

Documentation

Overview

Package gstructs provides functions for struct information retrieving.

Index

• func FieldMap(in FieldMapInput) (map[string]Field, error)
• func ParseTag(tag string) map[string]string
• func TagMapField(object interface{}, priority []string) (map[string]Field, error)
• func TagMapName(pointer interface{}, priority []string) (map[string]string, error)
• type Field
  • func Fields(in FieldsInput) ([]Field, error)
  • func TagFields(pointer interface{}, priority []string) ([]Field, error)
  • func (f *Field) IsEmbedded() bool
  • func (f *Field) IsExported() bool
  • func (f *Field) Kind() reflect.Kind
  • func (f *Field) Name() string
  • func (f *Field) OriginalKind() reflect.Kind
  • func (f *Field) Tag(key string) string
  • func (f *Field) TagAdditional() string
  • func (f *Field) TagDefault() string
  • func (f *Field) TagDescription() string
  • func (f *Field) TagExample() string
  • func (f *Field) TagJsonName() string
  • func (f *Field) TagLookup(key string) (value string, ok bool)
  • func (f *Field) TagMap() map[string]string
  • func (f *Field) TagParam() string
  • func (f *Field) TagStr() string
  • func (f *Field) TagSummary() string
  • func (f *Field) TagValid() string
  • func (f *Field) Type() Type
• type FieldMapInput
• type FieldsInput
• type RecursiveOption
• type Type
  • func StructType(object interface{}) (*Type, error)
  • func (t Type) FieldKeys() []string
  • func (t Type) Signature() string

Functions

func FieldMap

func FieldMap(in FieldMapInput) (map[string]Field, error)

FieldMap retrieves and returns struct field as map[name/tag]Field from `pointer`.

The parameter `pointer` should be type of struct/*struct.

The parameter `priority` specifies the priority tag array for retrieving from high to low. If it's given `nil`, it returns map[name]Field, of which the `name` is attribute name.

The parameter `recursive` specifies the whether retrieving the fields recursively if the attribute is an embedded struct.

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

func ParseTag

func ParseTag(tag string) map[string]string

ParseTag parses tag string into map. For example: ParseTag(`v:"required" p:"id" d:"1"`) => map[v:required p:id d:1].

func TagMapField

func TagMapField(object interface{}, priority []string) (map[string]Field, error)

TagMapField retrieves struct tags as map[tag]Field from `pointer`, and returns it. The parameter `object` should be either type of struct/*struct/[]struct/[]*struct.

Note that, 1. It only retrieves the exported attributes with first letter up-case from struct. 2. The parameter `priority` should be given, it only retrieves fields that has given tag. 3. If one field has no specified tag, it uses its field name as result map key.

func TagMapName

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

TagMapName retrieves and returns struct tags as map[tag]attribute from `pointer`.

The parameter `pointer` should be type of struct/*struct.

Note that, 1. It only retrieves the exported attributes with first letter up-case from struct. 2. The parameter `priority` should be given, it only retrieves fields that has given tag. 3. If one field has no specified tag, it uses its field name as result map key.

Types

type Field

type Field struct {
	Value reflect.Value       // The underlying value of the field.
	Field reflect.StructField // The underlying field of the field.

	// Retrieved tag name. It depends TagValue.
	TagName string

	// Retrieved tag value.
	// There might be more than one tags in the field, but only one can be retrieved according to calling function rules.
	TagValue string
}

Field contains information of a struct field .

func Fields

func Fields(in FieldsInput) ([]Field, error)

Fields retrieves and returns the fields of `pointer` as slice.

func TagFields

func TagFields(pointer interface{}, priority []string) ([]Field, error)

TagFields retrieves and returns struct tags as []Field from `pointer`.

The parameter `pointer` should be type of struct/*struct.

Note that, 1. It only retrieves the exported attributes with first letter up-case from struct. 2. The parameter `priority` should be given, it only retrieves fields that has given tag.

func (*Field) IsEmbedded

func (f *Field) IsEmbedded() bool

IsEmbedded returns true if the given field is an anonymous field (embedded)

func (*Field) IsExported

func (f *Field) IsExported() bool

IsExported returns true if the given field is exported.

func (*Field) Kind

func (f *Field) Kind() reflect.Kind

Kind returns the reflect.Kind for Value of Field `f`.

func (*Field) Name

func (f *Field) Name() string

Name returns the name of the given field.

func (*Field) OriginalKind

func (f *Field) OriginalKind() reflect.Kind

OriginalKind retrieves and returns the original reflect.Kind for Value of Field `f`.

func (*Field) Tag

func (f *Field) Tag(key string) string

Tag returns the value associated with key in the tag string. If there is no such key in the tag, Tag returns the empty string.

func (*Field) TagAdditional

func (f *Field) TagAdditional() string

TagAdditional returns the most commonly used tag `additional/ad` value of the field.

func (*Field) TagDefault

func (f *Field) TagDefault() string

TagDefault returns the most commonly used tag `default/d` value of the field.

func (*Field) TagDescription

func (f *Field) TagDescription() string

TagDescription returns the most commonly used tag `description/des/dc` value of the field.

func (*Field) TagExample

func (f *Field) TagExample() string

TagExample returns the most commonly used tag `example/eg` value of the field.

func (*Field) TagJsonName

func (f *Field) TagJsonName() string

TagJsonName returns the `json` tag name string of the field.

func (*Field) TagLookup

func (f *Field) TagLookup(key string) (value string, ok bool)

TagLookup returns the value associated with key in the tag string. If the key is present in the tag the value (which may be empty) is returned. Otherwise, the returned value will be the empty string. The ok return value reports whether the value was explicitly set in the tag string. If the tag does not have the conventional format, the value returned by Lookup is unspecified.

func (*Field) TagMap

func (f *Field) TagMap() map[string]string

TagMap returns all the tag of the field along with its value string as map.

func (*Field) TagParam

func (f *Field) TagParam() string

TagParam returns the most commonly used tag `param/p` value of the field.

func (*Field) TagStr

func (f *Field) TagStr() string

TagStr returns the tag string of the field.

func (*Field) TagSummary

func (f *Field) TagSummary() string

TagSummary returns the most commonly used tag `summary/sum/sm` value of the field.

func (*Field) TagValid

func (f *Field) TagValid() string

TagValid returns the most commonly used tag `valid/v` value of the field.

func (*Field) Type

func (f *Field) Type() Type

Type returns the type of the given field. Note that this Type is not reflect.Type. If you need reflect.Type, please use Field.Type().Type.

type FieldMapInput

type FieldMapInput struct {
	// Pointer should be type of struct/*struct.
	Pointer interface{}

	// PriorityTagArray specifies the priority tag array for retrieving from high to low.
	// If it's given `nil`, it returns map[name]Field, of which the `name` is attribute name.
	PriorityTagArray []string

	// RecursiveOption specifies the way retrieving the fields recursively if the attribute
	// is an embedded struct. It is RecursiveOptionNone in default.
	RecursiveOption RecursiveOption
}

FieldMapInput is the input parameter struct type for function FieldMap.

type FieldsInput

type FieldsInput struct {
	// Pointer should be type of struct/*struct.
	Pointer interface{}

	// RecursiveOption specifies the way retrieving the fields recursively if the attribute
	// is an embedded struct. It is RecursiveOptionNone in default.
	RecursiveOption RecursiveOption
}

FieldsInput is the input parameter struct type for function Fields.

type RecursiveOption

type RecursiveOption int

const (
	RecursiveOptionNone          RecursiveOption = 0 // No recursively retrieving fields as map if the field is an embedded struct.
	RecursiveOptionEmbedded      RecursiveOption = 1 // Recursively retrieving fields as map if the field is an embedded struct.
	RecursiveOptionEmbeddedNoTag RecursiveOption = 2 // Recursively retrieving fields as map if the field is an embedded struct and the field has no tag.
)

type Type

type Type struct {
	reflect.Type
}

Type wraps reflect.Type for additional features.

func StructType

func StructType(object interface{}) (*Type, error)

StructType retrieves and returns the struct Type of specified struct/*struct. The parameter `object` should be either type of struct/*struct/[]struct/[]*struct.

func (Type) FieldKeys

func (t Type) FieldKeys() []string

FieldKeys returns the keys of current struct/map.

func (Type) Signature

func (t Type) Signature() string

Signature returns a unique string as this type.