Package: github.com/fatih/structs

package structs Import Path github.com/fatih/structs (on go.dev) Dependency Relation imports 4 packages, and imported by one package Involved Source Files field.go d➜ structs.go Package structs contains various utilities functions to work with structs. tags.go Package-Level Type Names (total 3, in which 2 are exported) /* sort exporteds by: alphabet | popularity */ type Field (struct) Field represents a single struct field that encapsulates high level functions around the field. Fields (total 3, none are exported) /* 3 unexporteds ... *//* 3 unexporteds: */ defaultTag string field reflect.StructField value reflect.Value Methods (total 12, all are exported) (*T) Field(name string) *Field Field returns the field from a nested struct. It panics if the nested struct is not exported or if the field was not found. (*T) FieldOk(name string) (*Field, bool) FieldOk returns the field from a nested struct. The boolean returns whether the field was found (true) or not (false). (*T) Fields() []*Field Fields returns a slice of Fields. This is particular handy to get the fields of a nested struct . A struct tag with the content of "-" ignores the checking of that particular field. Example: // Field is ignored by this package. Field *http.Request `structs:"-"` It panics if field is not exported or if field's kind is not struct (*T) IsEmbedded() bool IsEmbedded returns true if the given field is an anonymous field (embedded) (*T) IsExported() bool IsExported returns true if the given field is exported. (*T) IsZero() bool IsZero returns true if the given field is not initialized (has a zero value). It panics if the field is not exported. (*T) Kind() reflect.Kind Kind returns the fields kind, such as "string", "map", "bool", etc .. (*T) Name() string Name returns the name of the given field (*T) Set(val interface{}) error Set sets the field to given value v. It returns an error if the field is not settable (not addressable or not exported) or if the given value's type doesn't match the fields type. (*T) 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. (*T) Value() interface{} Value returns the underlying value of the field. It panics if the field is not exported. (*T) Zero() error Zero sets the field to its zero value. It returns an error if the field is not settable (not addressable or not exported). Implements (at least 2, both are exported) *T : gopkg.in/yaml.v2.IsZeroer *T : gopkg.in/yaml.v3.IsZeroer As Outputs Of (at least 8, in which 7 are exported) func Fields(s interface{}) []*Field func (*Field).Field(name string) *Field func (*Field).FieldOk(name string) (*Field, bool) func (*Field).Fields() []*Field func (*Struct).Field(name string) *Field func (*Struct).FieldOk(name string) (*Field, bool) func (*Struct).Fields() []*Field /* at least one unexported ... *//* at least one unexported: */ func getFields(v reflect.Value, tagName string) []*Field type Struct (struct) Struct encapsulates a struct type to provide several high level functions around the struct. Fields (total 3, in which 1 are exported) TagName string /* 2 unexporteds ... *//* 2 unexporteds: */ raw interface{} value reflect.Value Methods (total 12, in which 10 are exported) (*T) Field(name string) *Field Field returns a new Field struct that provides several high level functions around a single struct field entity. It panics if the field is not found. (*T) FieldOk(name string) (*Field, bool) FieldOk returns a new Field struct that provides several high level functions around a single struct field entity. The boolean returns true if the field was found. (*T) Fields() []*Field Fields returns a slice of Fields. A struct tag with the content of "-" ignores the checking of that particular field. Example: // Field is ignored by this package. Field bool `structs:"-"` It panics if s's kind is not struct. (*T) FillMap(out map[string]interface{}) FillMap is the same as Map. Instead of returning the output, it fills the given map. (*T) HasZero() bool HasZero returns true if a field in a struct is not initialized (zero value). A struct tag with the content of "-" ignores the checking of that particular field. Example: // Field is ignored by this package. Field bool `structs:"-"` A value with the option of "omitnested" stops iterating further if the type is a struct. Example: // Field is not processed further by this package. Field time.Time `structs:"myName,omitnested"` Field *http.Request `structs:",omitnested"` Note that only exported fields of a struct can be accessed, non exported fields will be neglected. It panics if s's kind is not struct. (*T) IsZero() bool IsZero returns true if all fields in a struct is a zero value (not initialized) A struct tag with the content of "-" ignores the checking of that particular field. Example: // Field is ignored by this package. Field bool `structs:"-"` A value with the option of "omitnested" stops iterating further if the type is a struct. Example: // Field is not processed further by this package. Field time.Time `structs:"myName,omitnested"` Field *http.Request `structs:",omitnested"` Note that only exported fields of a struct can be accessed, non exported fields will be neglected. It panics if s's kind is not struct. (*T) Map() map[string]interface{} Map converts the given struct to a map[string]interface{}, where the keys of the map are the field names and the values of the map the associated values of the fields. The default key string is the struct field name but can be changed in the struct field's tag value. The "structs" key in the struct's field tag value is the key name. Example: // Field appears in map as key "myName". Name string `structs:"myName"` A tag value with the content of "-" ignores that particular field. Example: // Field is ignored by this package. Field bool `structs:"-"` A tag value with the content of "string" uses the stringer to get the value. Example: // The value will be output of Animal's String() func. // Map will panic if Animal does not implement String(). Field *Animal `structs:"field,string"` A tag value with the option of "flatten" used in a struct field is to flatten its fields in the output map. Example: // The FieldStruct's fields will be flattened into the output map. FieldStruct time.Time `structs:",flatten"` A tag value with the option of "omitnested" stops iterating further if the type is a struct. Example: // Field is not processed further by this package. Field time.Time `structs:"myName,omitnested"` Field *http.Request `structs:",omitnested"` A tag value with the option of "omitempty" ignores that particular field if the field value is empty. Example: // Field appears in map as key "myName", but the field is // skipped if empty. Field string `structs:"myName,omitempty"` // Field appears in map as key "Field" (the default), but // the field is skipped if empty. Field string `structs:",omitempty"` Note that only exported fields of a struct can be accessed, non exported fields will be neglected. (*T) Name() string Name returns the structs's type name within its package. For more info refer to Name() function. (*T) Names() []string Names returns a slice of field names. A struct tag with the content of "-" ignores the checking of that particular field. Example: // Field is ignored by this package. Field bool `structs:"-"` It panics if s's kind is not struct. (*T) Values() []interface{} Values converts the given s struct's field values to a []interface{}. A struct tag with the content of "-" ignores the that particular field. Example: // Field is ignored by this package. Field int `structs:"-"` A value with the option of "omitnested" stops iterating further if the type is a struct. Example: // Fields is not processed further by this package. Field time.Time `structs:",omitnested"` Field *http.Request `structs:",omitnested"` A tag value with the option of "omitempty" ignores that particular field and is not added to the values if the field value is empty. Example: // Field is skipped if empty Field string `structs:",omitempty"` Note that only exported fields of a struct can be accessed, non exported fields will be neglected. /* 2 unexporteds ... *//* 2 unexporteds: */ (*T) nested(val reflect.Value) interface{} nested retrieves recursively all types for the given value and returns the nested value. (*T) structFields() []reflect.StructField structFields returns the exported struct fields for a given s struct. This is a convenient helper method to avoid duplicate code in some of the functions. Implements (at least 2, both are exported) *T : gopkg.in/yaml.v2.IsZeroer *T : gopkg.in/yaml.v3.IsZeroer As Outputs Of (at least one exported) func New(s interface{}) *Struct /* one unexported ... *//* one unexported: */ type tagOptions ([]T) tagOptions contains a slice of tag options Methods (only one, which is exported) ( T) Has(opt string) bool Has returns true if the given option is available in tagOptions As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func parseTag(tag string) (string, tagOptions) Package-Level Functions (total 13, in which 10 are exported) func Fields(s interface{}) []*Field Fields returns a slice of *Field. For more info refer to Struct types Fields() method. It panics if s's kind is not struct. func FillMap(s interface{}, out map[string]interface{}) FillMap is the same as Map. Instead of returning the output, it fills the given map. func HasZero(s interface{}) bool HasZero returns true if any field is equal to a zero value. For more info refer to Struct types HasZero() method. It panics if s's kind is not struct. func IsStruct(s interface{}) bool IsStruct returns true if the given variable is a struct or a pointer to struct. func IsZero(s interface{}) bool IsZero returns true if all fields is equal to a zero value. For more info refer to Struct types IsZero() method. It panics if s's kind is not struct. func Map(s interface{}) map[string]interface{} Map converts the given struct to a map[string]interface{}. For more info refer to Struct types Map() method. It panics if s's kind is not struct. func Name(s interface{}) string Name returns the structs's type name within its package. It returns an empty string for unnamed types. It panics if s's kind is not struct. func Names(s interface{}) []string Names returns a slice of field names. For more info refer to Struct types Names() method. It panics if s's kind is not struct. func New(s interface{}) *Struct New returns a new *Struct with the struct s. It panics if the s's kind is not struct. func Values(s interface{}) []interface{} Values converts the given struct to a []interface{}. For more info refer to Struct types Values() method. It panics if s's kind is not struct. /* 3 unexporteds ... *//* 3 unexporteds: */ func getFields(v reflect.Value, tagName string) []*Field func parseTag(tag string) (string, tagOptions) parseTag splits a struct field's tag into its name and a list of options which comes after a name. A tag is in the form of: "name,option1,option2". The name can be neglectected. func strctVal(s interface{}) reflect.Value Package-Level Variables (total 3, in which 1 are exported) var DefaultTagName string // struct's field default tag name DefaultTagName is the default tag name for struct fields which provides a more granular to tweak certain structs. Lookup the necessary functions for more info. /* 2 unexporteds ... *//* 2 unexporteds: */ var errNotExported error var errNotSettable error

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.