1 // Copyright (c) 2020-2023 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 21 package atomic 22 23 //go:generate bin/gen-atomicwrapper -name=String -type=string -wrapped Value -pack packString -unpack unpackString -compareandswap -swap -file=string.go 24 25 func packString(s string) interface{} { 26 return s 27 } 28 29 func unpackString(v interface{}) string { 30 if s, ok := v.(string); ok { 31 return s 32 } 33 return "" 34 } 35 36 // String returns the wrapped value. 37 func (s *String) String() string { 38 return s.Load() 39 } 40 41 // MarshalText encodes the wrapped string into a textual form. 42 // 43 // This makes it encodable as JSON, YAML, XML, and more. 44 func (s *String) MarshalText() ([]byte, error) { 45 return []byte(s.Load()), nil 46 } 47 48 // UnmarshalText decodes text and replaces the wrapped string with it. 49 // 50 // This makes it decodable from JSON, YAML, XML, and more. 51 func (s *String) UnmarshalText(b []byte) error { 52 s.Store(string(b)) 53 return nil 54 } 55