blob: a6166fbea01e12c1f0cc3450a5e22d57a5c19e28 [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.
divyadesai19009132020-03-04 12:58:08 +00004//
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
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000025// Error is an atomic type-safe wrapper for error values.
26type Error struct {
27 _ nocmp // disallow non-atomic comparison
divyadesai19009132020-03-04 12:58:08 +000028
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000029 v Value
divyadesai19009132020-03-04 12:58:08 +000030}
31
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000032var _zeroError error
divyadesai19009132020-03-04 12:58:08 +000033
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000034// NewError creates a new Error.
35func NewError(v error) *Error {
36 x := &Error{}
37 if v != _zeroError {
38 x.Store(v)
39 }
40 return x
divyadesai19009132020-03-04 12:58:08 +000041}
42
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000043// Load atomically loads the wrapped error.
44func (x *Error) Load() error {
45 return unpackError(x.v.Load())
46}
47
48// Store atomically stores the passed error.
49func (x *Error) Store(v error) {
50 x.v.Store(packError(v))
divyadesai19009132020-03-04 12:58:08 +000051}