epicknex/structs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Fatih Arslan 2014-10-28 19:35:47 +02:00
parent e1ea13a2d5
commit 6321ca4452
1 changed files with 40 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
README.md
View File

@ -14,7 +14,9 @@ go get github.com/fatih/structs
## Usage and Examples ## Usage and Examples
Lets define and declare a struct Just like the standard lib `strings`, `bytes` and co packages, `structs` has
many global functions to manipulate or organize your struct data Lets define
and declare a struct:
```go ```go
type Server struct { type Server struct {
@ -32,52 +34,50 @@ server := &Server{
} }
``` ```
```go
// Convert a struct to a map[string]interface{}
// => {"Name":"gopher", "ID":123456, "Enabled":true}
m := structs.Map(s)
// Convert the values of a struct to a []interface{}
// => ["gopher", 123456, true]
v := structs.Values(s)
// Convert the values of a struct to a []*Field
// (see "Field methods" for more info about fields)
f := structs.Fields(s) // Get a []*Field
// Return the struct name => "Server"
n := structs.Name(s) // Get the struct name
// Check if any field of a struct is initialized or not.
h := structs.HasZero(s) // Check if any field is initialized
// Check if all fields of a struct is initialized or not.
z := structs.IsZero(s) // Check if all fields are initialized
// Check if s is a struct or a pointer to struct
i := structs.IsStruct(s)
```
### Struct methods ### Struct methods
Let's create a new `Struct` type. The structs functions can be also used as independent methods by creating a new
`*structs.Struct`. This is handy if you want to have more control over the
structs (such as retrieving a single Field).
```go ```go
// Create a new struct type: // Create a new struct type:
s := structs.New(server) s := structs.New(server)
// Convert a struct to a map[string]interface{} m := s.Map() // Get a map[string]interface{}
// => {"Name":"gopher", "ID":123456, "Enabled":true} v := s.Values() // Get a []interface{}
m := s.Map() f := s.Fields() // Get a []*Field
f := s.Field(name) // Get a *Field based on the given field name
// Convert the values of a struct to a []interface{} f, ok := s.FieldsOk(name) // Get a *Field based on the given field name
// => ["gopher", 123456, true] n := s.Name() // Get the struct name
v := s.Values() h := s.HasZero() // Check if any field is initialized
z := s.IsZero() // Check if all fields are initialized
// Convert the values of a struct to a []*Field
// (see "Field methods" for more info about fields)
f := s.Fields()
// Check if any field of a struct is initialized or not.
if s.HasZero() {
fmt.Println("s has a zero value field")
}
// Check if all fields of a struct is initialized or not.
if s.IsZero() {
fmt.Println("all fields of s is zero value")
}
// Return the struct name
// => "Server"
n := s.Name()
```
Most of the struct methods are available as global functions without the need
for a `New()` constructor:
```go
m := structs.Map(s) // Get a map[string]interface{}
v := structs.Values(s) // Get a []interface{}
f := structs.Fields(s) // Get a []*Field
n := structs.Name(s) // Get the struct name
h := structs.HasZero(s) // Check if any field is initialized
z := structs.IsZero(s) // Check if all fields are initialized
i := structs.IsStruct(s) // Check if s is a struct or a pointer to struct
``` ```
### Field methods ### Field methods
@ -157,5 +157,3 @@ for _, f := range fields {
## License ## License
The MIT License (MIT) - see LICENSE.md for more details The MIT License (MIT) - see LICENSE.md for more details