blob: 9cf1914b1f826cb1bfb1619fbcf3f10e3f870a54 [file] [log] [blame]
David K. Bainbridgebd6b2882021-08-26 13:31:02 +00001// @generated Code generated by gen-atomicwrapper.
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)
28
29// Bool is an atomic type-safe wrapper for bool values.
30type Bool struct {
31 _ nocmp // disallow non-atomic comparison
32
33 v Uint32
34}
35
36var _zeroBool bool
37
38// NewBool creates a new Bool.
39func NewBool(v bool) *Bool {
40 x := &Bool{}
41 if v != _zeroBool {
42 x.Store(v)
43 }
44 return x
45}
46
47// Load atomically loads the wrapped bool.
48func (x *Bool) Load() bool {
49 return truthy(x.v.Load())
50}
51
52// Store atomically stores the passed bool.
53func (x *Bool) Store(v bool) {
54 x.v.Store(boolToInt(v))
55}
56
57// CAS is an atomic compare-and-swap for bool values.
58func (x *Bool) CAS(o, n bool) bool {
59 return x.v.CAS(boolToInt(o), boolToInt(n))
60}
61
62// Swap atomically stores the given bool and returns the old
63// value.
64func (x *Bool) Swap(o bool) bool {
65 return truthy(x.v.Swap(boolToInt(o)))
66}
67
68// MarshalJSON encodes the wrapped bool into JSON.
69func (x *Bool) MarshalJSON() ([]byte, error) {
70 return json.Marshal(x.Load())
71}
72
73// UnmarshalJSON decodes a bool from JSON.
74func (x *Bool) UnmarshalJSON(b []byte) error {
75 var v bool
76 if err := json.Unmarshal(b, &v); err != nil {
77 return err
78 }
79 x.Store(v)
80 return nil
81}