db.v3: upper.io/db.v3/lib/reflectx Index | Files

package reflectx

import "upper.io/db.v3/lib/reflectx"

Package reflectx implements extensions to the standard reflect lib suitable for implementing marshaling and unmarshaling packages. The main Mapper type allows for Go-compatible named attribute access, including accessing embedded struct attributes and the ability to use functions and struct tags to customize field names.

Index

Package Files

reflect.go

func Deref Uses

func Deref(t reflect.Type) reflect.Type

Deref is Indirect for reflect.Types

func FieldByIndexes Uses

func FieldByIndexes(v reflect.Value, indexes []int) reflect.Value

FieldByIndexes returns a value for a particular struct traversal.

func FieldByIndexesReadOnly Uses

func FieldByIndexesReadOnly(v reflect.Value, indexes []int) reflect.Value

FieldByIndexesReadOnly returns a value for a particular struct traversal, but is not concerned with allocating nil pointers because the value is going to be used for reading and not setting.

func ValidFieldByIndexes Uses

func ValidFieldByIndexes(v reflect.Value, indexes []int) reflect.Value

ValidFieldByIndexes returns a value for a particular struct traversal.

type FieldInfo Uses

type FieldInfo struct {
    Index    []int
    Path     string
    Field    reflect.StructField
    Zero     reflect.Value
    Name     string
    Options  map[string]string
    Embedded bool
    Children []*FieldInfo
    Parent   *FieldInfo
}

A FieldInfo is a collection of metadata about a struct field.

type Mapper Uses

type Mapper struct {
    // contains filtered or unexported fields
}

Mapper is a general purpose mapper of names to struct fields. A Mapper behaves like most marshallers, optionally obeying a field tag for name mapping and a function to provide a basic mapping of fields to names.

func NewMapper Uses

func NewMapper(tagName string) *Mapper

NewMapper returns a new mapper which optionally obeys the field tag given by tagName. If tagName is the empty string, it is ignored.

func NewMapperFunc Uses

func NewMapperFunc(tagName string, f func(string) string) *Mapper

NewMapperFunc returns a new mapper which optionally obeys a field tag and a struct field name mapper func given by f. Tags will take precedence, but for any other field, the mapped name will be f(field.Name)

func NewMapperTagFunc Uses

func NewMapperTagFunc(tagName string, mapFunc, tagMapFunc func(string) string) *Mapper

NewMapperTagFunc returns a new mapper which contains a mapper for field names AND a mapper for tag values. This is useful for tags like json which can have values like "name,omitempty".

func (*Mapper) FieldByName Uses

func (m *Mapper) FieldByName(v reflect.Value, name string) reflect.Value

FieldByName returns a field by the its mapped name as a reflect.Value. Panics if v's Kind is not Struct or v is not Indirectable to a struct Kind. Returns zero Value if the name is not found.

func (*Mapper) FieldMap Uses

func (m *Mapper) FieldMap(v reflect.Value) map[string]reflect.Value

FieldMap returns the mapper's mapping of field names to reflect values. Panics if v's Kind is not Struct, or v is not Indirectable to a struct kind.

func (*Mapper) FieldsByName Uses

func (m *Mapper) FieldsByName(v reflect.Value, names []string) []reflect.Value

FieldsByName returns a slice of values corresponding to the slice of names for the value. Panics if v's Kind is not Struct or v is not Indirectable to a struct Kind. Returns zero Value for each name not found.

func (*Mapper) TraversalsByName Uses

func (m *Mapper) TraversalsByName(t reflect.Type, names []string) [][]int

TraversalsByName returns a slice of int slices which represent the struct traversals for each mapped name. Panics if t is not a struct or Indirectable to a struct. Returns empty int slice for each name not found.

func (*Mapper) TypeMap Uses

func (m *Mapper) TypeMap(t reflect.Type) *StructMap

TypeMap returns a mapping of field strings to int slices representing the traversal down the struct to reach the field.

func (*Mapper) ValidFieldMap Uses

func (m *Mapper) ValidFieldMap(v reflect.Value) map[string]reflect.Value

ValidFieldMap returns the mapper's mapping of field names to reflect valid field values. Panics if v's Kind is not Struct, or v is not Indirectable to a struct kind.

type StructMap Uses

type StructMap struct {
    Tree  *FieldInfo
    Index []*FieldInfo
    Paths map[string]*FieldInfo
    Names map[string]*FieldInfo
}

A StructMap is an index of field metadata for a struct.

func (StructMap) GetByPath Uses

func (f StructMap) GetByPath(path string) *FieldInfo

GetByPath returns a *FieldInfo for a given string path.

func (StructMap) GetByTraversal Uses

func (f StructMap) GetByTraversal(index []int) *FieldInfo

GetByTraversal returns a *FieldInfo for a given integer path. It is analogous to reflect.FieldByIndex.

Package reflectx imports 5 packages (graph) and is imported by 4 packages. Updated 2018-11-03. Refresh now. Tools for package owners.