github.com/gogf/gf/v2@v2.7.4/container/gtype/gtype_uint.go (about)

     1  // Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
     2  //
     3  // This Source Code Form is subject to the terms of the MIT License.
     4  // If a copy of the MIT was not distributed with this file,
     5  // You can obtain one at https://github.com/gogf/gf.
     6  
     7  package gtype
     8  
     9  import (
    10  	"strconv"
    11  	"sync/atomic"
    12  
    13  	"github.com/gogf/gf/v2/util/gconv"
    14  )
    15  
    16  // Uint is a struct for concurrent-safe operation for type uint.
    17  type Uint struct {
    18  	value uint64
    19  }
    20  
    21  // NewUint creates and returns a concurrent-safe object for uint type,
    22  // with given initial value `value`.
    23  func NewUint(value ...uint) *Uint {
    24  	if len(value) > 0 {
    25  		return &Uint{
    26  			value: uint64(value[0]),
    27  		}
    28  	}
    29  	return &Uint{}
    30  }
    31  
    32  // Clone clones and returns a new concurrent-safe object for uint type.
    33  func (v *Uint) Clone() *Uint {
    34  	return NewUint(v.Val())
    35  }
    36  
    37  // Set atomically stores `value` into t.value and returns the previous value of t.value.
    38  func (v *Uint) Set(value uint) (old uint) {
    39  	return uint(atomic.SwapUint64(&v.value, uint64(value)))
    40  }
    41  
    42  // Val atomically loads and returns t.value.
    43  func (v *Uint) Val() uint {
    44  	return uint(atomic.LoadUint64(&v.value))
    45  }
    46  
    47  // Add atomically adds `delta` to t.value and returns the new value.
    48  func (v *Uint) Add(delta uint) (new uint) {
    49  	return uint(atomic.AddUint64(&v.value, uint64(delta)))
    50  }
    51  
    52  // Cas executes the compare-and-swap operation for value.
    53  func (v *Uint) Cas(old, new uint) (swapped bool) {
    54  	return atomic.CompareAndSwapUint64(&v.value, uint64(old), uint64(new))
    55  }
    56  
    57  // String implements String interface for string printing.
    58  func (v *Uint) String() string {
    59  	return strconv.FormatUint(uint64(v.Val()), 10)
    60  }
    61  
    62  // MarshalJSON implements the interface MarshalJSON for json.Marshal.
    63  func (v Uint) MarshalJSON() ([]byte, error) {
    64  	return []byte(strconv.FormatUint(uint64(v.Val()), 10)), nil
    65  }
    66  
    67  // UnmarshalJSON implements the interface UnmarshalJSON for json.Unmarshal.
    68  func (v *Uint) UnmarshalJSON(b []byte) error {
    69  	v.Set(gconv.Uint(string(b)))
    70  	return nil
    71  }
    72  
    73  // UnmarshalValue is an interface implement which sets any type of value for `v`.
    74  func (v *Uint) UnmarshalValue(value interface{}) error {
    75  	v.Set(gconv.Uint(value))
    76  	return nil
    77  }
    78  
    79  // DeepCopy implements interface for deep copy of current type.
    80  func (v *Uint) DeepCopy() interface{} {
    81  	if v == nil {
    82  		return nil
    83  	}
    84  	return NewUint(v.Val())
    85  }