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 (f *Field) IsEmbedded() bool
- func (f *Field) IsEmpty() bool
- func (f *Field) IsExported() bool
- func (f *Field) IsNil(traceSource ...bool) bool
- func (f *Field) Kind() reflect.Kind
- func (f *Field) Name() string
- func (f *Field) OriginalKind() reflect.Kind
- func (f *Field) OriginalValue() reflect.Value
- 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) TagIn() 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) TagPriorityName() 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
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 whether retrieving the fields recursively if the attribute is an embedded struct.
Note that it only retrieves the exported attributes with first letter upper-case from struct.
func ParseTag ¶
ParseTag parses tag string into map. For example: ParseTag(`v:"required" p:"id" d:"1"`) => map[v:required p:id d:1].
func TagMapField ¶
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 upper-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 ¶
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 upper-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 ¶
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 upper-case from struct. 2. The parameter `priority` should be given, it only retrieves fields that has given tag.
func (*Field) IsEmbedded ¶
IsEmbedded returns true if the given field is an anonymous field (embedded)
func (*Field) IsEmpty ¶ added in v2.5.4
IsEmpty checks and returns whether the value of this Field is empty.
func (*Field) IsExported ¶
IsExported returns true if the given field is exported.
func (*Field) IsNil ¶ added in v2.5.4
IsNil checks and returns whether the value of this Field is nil.
func (*Field) OriginalKind ¶
OriginalKind retrieves and returns the original reflect.Kind for Value of Field `f`.
func (*Field) OriginalValue ¶ added in v2.6.2
OriginalValue retrieves and returns the original reflect.Value of Field `f`.
func (*Field) Tag ¶
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 ¶ added in v2.2.4
TagAdditional returns the most commonly used tag `additional/ad` value of the field.
func (*Field) TagDefault ¶ added in v2.2.4
TagDefault returns the most commonly used tag `default/d` value of the field.
func (*Field) TagDescription ¶ added in v2.2.4
TagDescription returns the most commonly used tag `description/des/dc` value of the field.
func (*Field) TagExample ¶ added in v2.2.4
TagExample returns the most commonly used tag `example/eg` value of the field.
func (*Field) TagIn ¶ added in v2.5.5
TagIn returns the most commonly used tag `in` value of the field.
func (*Field) TagJsonName ¶
TagJsonName returns the `json` tag name string of the field.
func (*Field) TagLookup ¶
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) TagParam ¶ added in v2.2.4
TagParam returns the most commonly used tag `param/p` value of the field.
func (*Field) TagPriorityName ¶ added in v2.6.3
TagPriorityName checks and returns tag name that matches the name item in `gtag.StructTagPriority`. It or else returns attribute field Name if it doesn't have a tag name by `gtag.StructsTagPriority`.
func (*Field) TagSummary ¶ added in v2.2.4
TagSummary returns the most commonly used tag `summary/sum/sm` value of the field.
type FieldMapInput ¶
type FieldMapInput struct {
// Pointer should be type of struct/*struct.
// TODO this attribute name is not suitable, which would make confuse.
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.
// TODO this attribute name is not suitable, which would make confuse.
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 ¶ added in v2.2.0
type RecursiveOption int
const ( RecursiveOptionNone RecursiveOption = iota // No recursively retrieving fields as map if the field is an embedded struct. RecursiveOptionEmbedded // Recursively retrieving fields as map if the field is an embedded struct. RecursiveOptionEmbeddedNoTag // Recursively retrieving fields as map if the field is an embedded struct and the field has no tag. )
type Type ¶
Type wraps reflect.Type for additional features.
func StructType ¶
StructType retrieves and returns the struct Type of specified struct/*struct. The parameter `object` should be either type of struct/*struct/[]struct/[]*struct.
Source Files