README
¶
The Value in go
Manipulates(gets,sets,convert etc.) interface{} value, convenient and simple, and reflect-based.
Features
You can do the following things, after new Value from interface{} like this v := value.New(var).
- Get value from map slice array or struct with key idx or fieldname
- Put key value pair to map slice or array
- Set value
- For range value any type
- Get value with Int*, Float*, PList etc.
- Numerical type is adaptive when get; example,
ikind is uint8 and get with Int16() is legal, the value is automatically converted to int16 instead of type mismatch. - Provide
Must*API, for chaining call and some friendly writing. - Unmarshal to a value with
Value.ConvTo - Supported covert to time.Duration or time.Time etc..
- Supported convert to frequently used build-in type
Example
convert v to net.IP, time.Duration etc..
package main
import (
"fmt"
"log"
"net"
"time"
"github.com/helloyi/go-value"
)
func main() {
x := map[string]interface{}{
"a": 1,
"B": "b",
"C": "c",
"D": "13s",
"E": "Fri Nov 1 19:13:55 +0800 CST 2019",
"F": "8.8.8.8",
}
var y struct {
A int `value:"a"` // set with name "a"
B int `value:"_"` // passed
C string // set with name "C"
D time.Duration
E *time.Time
F *net.IP
}
v := value.New(x)
if err := v.ConvTo(&y); err != nil {
log.Fatalln(err)
}
fmt.Printf("%v\n", y)
// Output: {1 0 c 13s 2019-11-01 19:13:55 +0800 CST 8.8.8.8}
}
Documentation
¶
Overview ¶
Package value manipulates(gets,sets,convert etc.) interface{} value, convenient and simple, and reflect-based.
Example ¶
resp, err := http.Get("https://api.alternative.me/fng/?limit=10")
if err != nil {
log.Fatalln(err)
}
defer resp.Body.Close()
data, err := ioutil.ReadAll(resp.Body)
if err != nil {
log.Fatalln(err)
}
var res interface{}
if err := json.Unmarshal(data, &res); err != nil {
log.Fatalln(err)
}
rest := value.New(res)
fngs := map[string]string{}
_ = rest.MustGet("data").EachDo(func(_, fng *value.Value) error {
ts, _ := fng.MustGet("timestamp").String()
val, _ := fng.MustGet("value").String()
fngs[ts] = val
return nil
})
data, err = json.MarshalIndent(fngs, "", " ")
if err != nil {
log.Fatalln(err)
}
log.Println(string(data))
Output:
Index ¶
- Variables
- func ConvTo(src, dst interface{}) error
- type ErrCannotBeNil
- type ErrCannotSet
- type ErrNotExist
- type ErrNumOverflow
- type ErrOutOfRange
- type ErrTypeUnequal
- type ErrUnsupportedKind
- type Value
- func (v *Value) AList() ([][2]*Value, error)
- func (v *Value) Bool() (bool, error)
- func (v *Value) Bytes() ([]byte, error)
- func (v *Value) Complex128() (complex128, error)
- func (v *Value) Complex64() (complex64, error)
- func (v *Value) ConvTo(dst interface{}) error
- func (v *Value) EachDo(f eachDoFunc) error
- func (v *Value) Float32() (float32, error)
- func (v *Value) Float64() (float64, error)
- func (v *Value) Get(k interface{}) (*Value, error)
- func (v *Value) Int() (i int, err error)
- func (v *Value) Int16() (int16, error)
- func (v *Value) Int32() (int32, error)
- func (v *Value) Int64() (int64, error)
- func (v *Value) Int8() (int8, error)
- func (v *Value) Interface() interface{}
- func (v *Value) Map() (map[*Value]*Value, error)
- func (v *Value) MustAList() [][2]*Value
- func (v *Value) MustBool() bool
- func (v *Value) MustBytes() []byte
- func (v *Value) MustComplex128() complex128
- func (v *Value) MustComplex64() complex64
- func (v *Value) MustFloat32() float32
- func (v *Value) MustFloat64() float64
- func (v *Value) MustGet(k interface{}) *Value
- func (v *Value) MustInt() int
- func (v *Value) MustInt16() int16
- func (v *Value) MustInt32() int32
- func (v *Value) MustInt64() int64
- func (v *Value) MustInt8() int8
- func (v *Value) MustMap() map[*Value]*Value
- func (v *Value) MustPList() []*Value
- func (v *Value) MustSlice() []*Value
- func (v *Value) MustString() string
- func (v *Value) MustUint() uint
- func (v *Value) MustUint16() uint16
- func (v *Value) MustUint32() uint32
- func (v *Value) MustUint64() uint64
- func (v *Value) MustUint8() uint8
- func (v *Value) PList() ([]*Value, error)
- func (v *Value) Ptr() uintptr
- func (v *Value) Put(key, val interface{}) (err error)
- func (v *Value) Set(iv interface{}) error
- func (v *Value) Slice() ([]*Value, error)
- func (v *Value) String() (string, error)
- func (v *Value) Uint() (i uint, err error)
- func (v *Value) Uint16() (uint16, error)
- func (v *Value) Uint32() (uint32, error)
- func (v *Value) Uint64() (uint64, error)
- func (v *Value) Uint8() (uint8, error)
Examples ¶
Constants ¶
This section is empty.
Variables ¶
var (
// TimeLayout default time layout
TimeLayout = "Mon Jan 2 15:04:05 -0700 MST 2006"
)
Functions ¶
Types ¶
type ErrCannotBeNil ¶
type ErrCannotBeNil struct {
Method string
}
ErrCannotBeNil ...
func (*ErrCannotBeNil) Error ¶
func (e *ErrCannotBeNil) Error() string
type ErrCannotSet ¶
type ErrCannotSet struct {
Method string
}
ErrCannotSet ...
func (*ErrCannotSet) Error ¶
func (e *ErrCannotSet) Error() string
type ErrNumOverflow ¶
ErrNumOverflow ...
func (*ErrNumOverflow) Error ¶
func (e *ErrNumOverflow) Error() string
type ErrOutOfRange ¶
type ErrOutOfRange struct {
Method string
}
ErrOutOfRange ...
func (*ErrOutOfRange) Error ¶
func (e *ErrOutOfRange) Error() string
type ErrTypeUnequal ¶
ErrTypeUnequal ...
func (*ErrTypeUnequal) Error ¶
func (e *ErrTypeUnequal) Error() string
type ErrUnsupportedKind ¶
type ErrUnsupportedKind struct {
Method string
Kind interface{}
}
ErrUnsupportedKind ...
func (*ErrUnsupportedKind) Error ¶
func (e *ErrUnsupportedKind) Error() string
type Value ¶
type Value struct {
// contains filtered or unexported fields
}
Value ...
func (*Value) AList ¶
AList returns t's underlying value as an association list. It returns error if t's kind is not Map, Array, Slice or Struct.
func (*Value) Bytes ¶
Bytes returns t's underlying value as a []bytes. It returns error if t's underlying value is not a slice of bytes.
func (*Value) Complex128 ¶
func (v *Value) Complex128() (complex128, error)
Complex128 returns t's underlying value as an complex128. It returns error if t's kind is not Uint*, Int*, Float* or Complex*.
func (*Value) Complex64 ¶
Complex64 returns t's underlying value as an complex64. It returns error if t's kind is not Uint*, Int*, Float32 or Complex64.
func (*Value) ConvTo ¶
ConvTo convToert t to dst
Example ¶
x := map[string]interface{}{
"a": 1,
"B": "b",
"C": "c",
"D": "13s",
"E": "Fri Nov 1 19:13:55 +0800 CST 2019",
"F": "8.8.8.8",
"G": "http://host/path?param=x",
"H": "[0-9]+",
"I": "name <uer@mail.com>",
}
var y struct {
A int `value:"a"` // set with name "a"
B int `value:"_"` // passed
C string // set with name "C"
D time.Duration
E *time.Time
F *net.IP
G *url.URL
H *regexp.Regexp
I *mail.Address
}
v := value.New(x)
if err := v.ConvTo(&y); err != nil {
log.Fatalln(err)
}
fmt.Printf("%v\n", y)
Output: {1 0 c 13s 2019-11-01 19:13:55 +0800 CST 8.8.8.8 http://host/path?param=x [0-9]+ "name" <uer@mail.com>}
func (*Value) EachDo ¶
EachDo ...
Example (Map) ¶
var m interface{} = map[int]int{
1: 1,
2: 2,
}
mv := value.New(m)
sum := 0
if err := mv.EachDo(func(key, val *value.Value) error {
sum += val.MustInt()
return nil
}); err != nil {
log.Fatalln(err)
}
fmt.Println(sum)
Output: 3
func (*Value) Float32 ¶
Float32 returns t's underlying value as an float32. It returns error if t's kind is not Uint*, Int* or Float32.
func (*Value) Float64 ¶
Float64 returns t's underlying value as an float64. It returns error if t's kind is not Uint*, Int* or Float*.
func (*Value) Get ¶
Get returns the value with the given key.
If t's kind is Map, Get returns the value associated with key in the map. If t's kind is Array or Slice, Get returns t's k'th element, the k must be int. If t's kind is Struct, Get returns the struct field with the given field name, the k must be string. if t's kind is Interface or Ptr, indirect it. It returns the nil if k is not found in the t. It returns error if t's kind is not Map, Array, Slice or Struct.
func (*Value) Int ¶
Int returns t's underlying value as an int. It returns error if t's kind is not Int, Int8, Int16, Int32, Uint8 or Uint16, and if t's kind is Int64 or Uint32 also Int is 32 bits.
func (*Value) Int16 ¶
Int16 returns t's underlying value as an int16. It returns error if t's kind is not Int, Int8, Int16, or Uint8.
func (*Value) Int32 ¶
Int32 returns t's underlying value as an int32. It returns error if t's kind is not Int, Int8, Int16, Int32, Uint8 or Uint16, and if t's kind is Int also Int is 64 bits.
func (*Value) Int64 ¶
Int64 returns t's underlying value as an int64. It returns error if t's kind is not Int, Int8, Int16, Int32, Uint8, Uint16, Uint32 and if t's kind is Uint also Uint is 64 bits.
func (*Value) Int8 ¶
Int8 returns t's underlying value as an int8. It returns error if t's kind is not Int8.
func (*Value) Map ¶
Map returns t's underlying value as a map. It returns error if t's kind is not Map, Array, Slice or Struct.
func (*Value) MustComplex128 ¶
func (v *Value) MustComplex128() complex128
MustComplex128 must api for Complex128()
func (*Value) MustComplex64 ¶
MustComplex64 must api for Complex64()
func (*Value) MustFloat32 ¶
MustFloat32 must api for Float32()
func (*Value) MustFloat64 ¶
MustFloat64 must api for Float64()
func (*Value) PList ¶
PList returns t's underlying value as an property list. It returns error if t's kind is not Map, Array, Slice or Struct.
func (*Value) Put ¶
Put put k, v to map, array, slice or struct(structed type).
If t's kind is map, the k indicates key of map. If t's kind is array/slice, the k indecates index of array/slice. If t's kind is struct, the k indecates fieldname of struct.
If k in t, and set k's value to v.
If t's kind is not map, array, slice or struct, returns ErrUnsupportedKind.
Example ¶
var m interface{} = map[int]int{
1: 1,
2: 2,
}
mv := value.New(m)
if err := mv.Put(1, 100); err != nil {
log.Fatalln(err)
}
fmt.Println(mv.MustGet(1).MustInt())
Output: 100
func (*Value) Set ¶
Set set t's value to v.
If t's value can't setable, returns ErrCannotSet. If t's kind and v's kind is not equivalence, returns ErrTypeUnequal. It returns nil, that set successful.
If set map key, struct field or array/slice index, using Value.Put.
func (*Value) Slice ¶
Slice returns t's underlying value as a slice. It returns error if t's kind is not Array, Slice or Struct.
func (*Value) Uint ¶
Uint returns t's underlying value as an uint. It returns error if t's kind is not Uint, Uint8, Uint16 or Uint32, and if t's kind is Uint64 also Uint is 32 bits.
func (*Value) Uint16 ¶
Uint16 returns t's underlying value as an uint16. It returns error if t's kind is not Uint8 or Uint16.
func (*Value) Uint32 ¶
Uint32 returns t's underlying value as an uint32. It returns error if t's kind is not Uint8, Uint16 or Uint32, and if t's kind is Uint also Uint is 64 bits.
Source Files