// Copyright GoFrame Author(https://goframe.org). All Rights Reserved. // // This Source Code Form is subject to the terms of the MIT License. // If a copy of the MIT was not distributed with this file, // You can obtain one at https://github.com/gogf/gf. // Package gvar provides an universal variable type, like generics. package gvar import ( "github.com/gogf/gf/internal/json" "time" "github.com/gogf/gf/container/gtype" "github.com/gogf/gf/os/gtime" "github.com/gogf/gf/util/gconv" ) // Var is an universal variable type implementer. type Var struct { value interface{} // Underlying value. safe bool // Concurrent safe or not. } // New creates and returns a new Var with given . // The optional parameter specifies whether Var is used in concurrent-safety, // which is false in default. func New(value interface{}, safe ...bool) *Var { v := Var{} if len(safe) > 0 && !safe[0] { v.safe = true v.value = gtype.NewInterface(value) } else { v.value = value } return &v } // Create creates and returns a new Var with given . // The optional parameter specifies whether Var is used in concurrent-safety, // which is false in default. func Create(value interface{}, safe ...bool) Var { v := Var{} if len(safe) > 0 && !safe[0] { v.safe = true v.value = gtype.NewInterface(value) } else { v.value = value } return v } // Clone does a shallow copy of current Var and returns a pointer to this Var. func (v *Var) Clone() *Var { return New(v.Val(), v.safe) } // Set sets to , and returns the old value. func (v *Var) Set(value interface{}) (old interface{}) { if v.safe { if t, ok := v.value.(*gtype.Interface); ok { old = t.Set(value) return } } old = v.value v.value = value return } // Val returns the current value of . func (v *Var) Val() interface{} { if v == nil { return nil } if v.safe { if t, ok := v.value.(*gtype.Interface); ok { return t.Val() } } return v.value } // Interface is alias of Val. func (v *Var) Interface() interface{} { return v.Val() } // Bytes converts and returns as []byte. func (v *Var) Bytes() []byte { return gconv.Bytes(v.Val()) } // String converts and returns as string. func (v *Var) String() string { return gconv.String(v.Val()) } // Bool converts and returns as bool. func (v *Var) Bool() bool { return gconv.Bool(v.Val()) } // Int converts and returns as int. func (v *Var) Int() int { return gconv.Int(v.Val()) } // Int8 converts and returns as int8. func (v *Var) Int8() int8 { return gconv.Int8(v.Val()) } // Int16 converts and returns as int16. func (v *Var) Int16() int16 { return gconv.Int16(v.Val()) } // Int32 converts and returns as int32. func (v *Var) Int32() int32 { return gconv.Int32(v.Val()) } // Int64 converts and returns as int64. func (v *Var) Int64() int64 { return gconv.Int64(v.Val()) } // Uint converts and returns as uint. func (v *Var) Uint() uint { return gconv.Uint(v.Val()) } // Uint8 converts and returns as uint8. func (v *Var) Uint8() uint8 { return gconv.Uint8(v.Val()) } // Uint16 converts and returns as uint16. func (v *Var) Uint16() uint16 { return gconv.Uint16(v.Val()) } // Uint32 converts and returns as uint32. func (v *Var) Uint32() uint32 { return gconv.Uint32(v.Val()) } // Uint64 converts and returns as uint64. func (v *Var) Uint64() uint64 { return gconv.Uint64(v.Val()) } // Float32 converts and returns as float32. func (v *Var) Float32() float32 { return gconv.Float32(v.Val()) } // Float64 converts and returns as float64. func (v *Var) Float64() float64 { return gconv.Float64(v.Val()) } // Time converts and returns as time.Time. // The parameter specifies the format of the time string using gtime, // eg: Y-m-d H:i:s. func (v *Var) Time(format ...string) time.Time { return gconv.Time(v.Val(), format...) } // Duration converts and returns as time.Duration. // If value of is string, then it uses time.ParseDuration for conversion. func (v *Var) Duration() time.Duration { return gconv.Duration(v.Val()) } // GTime converts and returns as *gtime.Time. // The parameter specifies the format of the time string using gtime, // eg: Y-m-d H:i:s. func (v *Var) GTime(format ...string) *gtime.Time { return gconv.GTime(v.Val(), format...) } // MarshalJSON implements the interface MarshalJSON for json.Marshal. func (v *Var) MarshalJSON() ([]byte, error) { return json.Marshal(v.Val()) } // UnmarshalJSON implements the interface UnmarshalJSON for json.Unmarshal. func (v *Var) UnmarshalJSON(b []byte) error { var i interface{} err := json.UnmarshalUseNumber(b, &i) if err != nil { return err } v.Set(i) return nil } // UnmarshalValue is an interface implement which sets any type of value for Var. func (v *Var) UnmarshalValue(value interface{}) error { v.Set(value) return nil }