blob: 3a9558213d0dcdc01dfeb724d6ba6d0efe54cb59 [file] [log] [blame]
khenaidoo106c61a2021-08-11 18:05:46 -04001// Copyright (c) 2020 Uber Technologies, Inc.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in
11// all copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19// THE SOFTWARE.
20
21package atomic
22
23//go:generate bin/gen-atomicwrapper -name=String -type=string -wrapped=Value -file=string.go
24
25// String returns the wrapped value.
26func (s *String) String() string {
27 return s.Load()
28}
29
30// MarshalText encodes the wrapped string into a textual form.
31//
32// This makes it encodable as JSON, YAML, XML, and more.
33func (s *String) MarshalText() ([]byte, error) {
34 return []byte(s.Load()), nil
35}
36
37// UnmarshalText decodes text and replaces the wrapped string with it.
38//
39// This makes it decodable from JSON, YAML, XML, and more.
40func (s *String) UnmarshalText(b []byte) error {
41 s.Store(string(b))
42 return nil
43}