bool.go 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. // @generated Code generated by gen-atomicwrapper.
  2. // Copyright (c) 2020-2023 Uber Technologies, Inc.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. package atomic
  22. import (
  23. "encoding/json"
  24. )
  25. // Bool is an atomic type-safe wrapper for bool values.
  26. type Bool struct {
  27. _ nocmp // disallow non-atomic comparison
  28. v Uint32
  29. }
  30. var _zeroBool bool
  31. // NewBool creates a new Bool.
  32. func NewBool(val bool) *Bool {
  33. x := &Bool{}
  34. if val != _zeroBool {
  35. x.Store(val)
  36. }
  37. return x
  38. }
  39. // Load atomically loads the wrapped bool.
  40. func (x *Bool) Load() bool {
  41. return truthy(x.v.Load())
  42. }
  43. // Store atomically stores the passed bool.
  44. func (x *Bool) Store(val bool) {
  45. x.v.Store(boolToInt(val))
  46. }
  47. // CAS is an atomic compare-and-swap for bool values.
  48. //
  49. // Deprecated: Use CompareAndSwap.
  50. func (x *Bool) CAS(old, new bool) (swapped bool) {
  51. return x.CompareAndSwap(old, new)
  52. }
  53. // CompareAndSwap is an atomic compare-and-swap for bool values.
  54. func (x *Bool) CompareAndSwap(old, new bool) (swapped bool) {
  55. return x.v.CompareAndSwap(boolToInt(old), boolToInt(new))
  56. }
  57. // Swap atomically stores the given bool and returns the old
  58. // value.
  59. func (x *Bool) Swap(val bool) (old bool) {
  60. return truthy(x.v.Swap(boolToInt(val)))
  61. }
  62. // MarshalJSON encodes the wrapped bool into JSON.
  63. func (x *Bool) MarshalJSON() ([]byte, error) {
  64. return json.Marshal(x.Load())
  65. }
  66. // UnmarshalJSON decodes a bool from JSON.
  67. func (x *Bool) UnmarshalJSON(b []byte) error {
  68. var v bool
  69. if err := json.Unmarshal(b, &v); err != nil {
  70. return err
  71. }
  72. x.Store(v)
  73. return nil
  74. }