blob: 225b7a2be0aa1eb557945d5c21c0493230c1c6fb [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// String is an atomic type-safe wrapper for string values.
26type String 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
30}
31
32var _zeroString string
33
34// NewString creates a new String.
35func NewString(v string) *String {
36 x := &String{}
37 if v != _zeroString {
38 x.Store(v)
divyadesai19009132020-03-04 12:58:08 +000039 }
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000040 return x
divyadesai19009132020-03-04 12:58:08 +000041}
42
43// Load atomically loads the wrapped string.
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000044func (x *String) Load() string {
45 if v := x.v.Load(); v != nil {
46 return v.(string)
divyadesai19009132020-03-04 12:58:08 +000047 }
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000048 return _zeroString
divyadesai19009132020-03-04 12:58:08 +000049}
50
51// Store atomically stores the passed string.
David K. Bainbridgebd6b2882021-08-26 13:31:02 +000052func (x *String) Store(v string) {
53 x.v.Store(v)
divyadesai19009132020-03-04 12:58:08 +000054}