blob: 3b6c71fd5a3721916b12643a192a99a4cca8dc36 [file] [log] [blame]
David K. Bainbridgebd6b2882021-08-26 13:31:02 +00001// @generated Code generated by gen-atomicint.
2
3// Copyright (c) 2020 Uber Technologies, Inc.
4//
5// Permission is hereby granted, free of charge, to any person obtaining a copy
6// of this software and associated documentation files (the "Software"), to deal
7// in the Software without restriction, including without limitation the rights
8// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9// copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21// THE SOFTWARE.
22
23package atomic
24
25import (
26 "encoding/json"
27 "strconv"
28 "sync/atomic"
29)
30
31// Uint64 is an atomic wrapper around uint64.
32type Uint64 struct {
33 _ nocmp // disallow non-atomic comparison
34
35 v uint64
36}
37
38// NewUint64 creates a new Uint64.
39func NewUint64(i uint64) *Uint64 {
40 return &Uint64{v: i}
41}
42
43// Load atomically loads the wrapped value.
44func (i *Uint64) Load() uint64 {
45 return atomic.LoadUint64(&i.v)
46}
47
48// Add atomically adds to the wrapped uint64 and returns the new value.
49func (i *Uint64) Add(n uint64) uint64 {
50 return atomic.AddUint64(&i.v, n)
51}
52
53// Sub atomically subtracts from the wrapped uint64 and returns the new value.
54func (i *Uint64) Sub(n uint64) uint64 {
55 return atomic.AddUint64(&i.v, ^(n - 1))
56}
57
58// Inc atomically increments the wrapped uint64 and returns the new value.
59func (i *Uint64) Inc() uint64 {
60 return i.Add(1)
61}
62
63// Dec atomically decrements the wrapped uint64 and returns the new value.
64func (i *Uint64) Dec() uint64 {
65 return i.Sub(1)
66}
67
68// CAS is an atomic compare-and-swap.
69func (i *Uint64) CAS(old, new uint64) bool {
70 return atomic.CompareAndSwapUint64(&i.v, old, new)
71}
72
73// Store atomically stores the passed value.
74func (i *Uint64) Store(n uint64) {
75 atomic.StoreUint64(&i.v, n)
76}
77
78// Swap atomically swaps the wrapped uint64 and returns the old value.
79func (i *Uint64) Swap(n uint64) uint64 {
80 return atomic.SwapUint64(&i.v, n)
81}
82
83// MarshalJSON encodes the wrapped uint64 into JSON.
84func (i *Uint64) MarshalJSON() ([]byte, error) {
85 return json.Marshal(i.Load())
86}
87
88// UnmarshalJSON decodes JSON into the wrapped uint64.
89func (i *Uint64) UnmarshalJSON(b []byte) error {
90 var v uint64
91 if err := json.Unmarshal(b, &v); err != nil {
92 return err
93 }
94 i.Store(v)
95 return nil
96}
97
98// String encodes the wrapped value as a string.
99func (i *Uint64) String() string {
100 v := i.Load()
101 return strconv.FormatUint(uint64(v), 10)
102}