cmd/bpa-operator/vendor/go.uber.org/atomic/string.go

   1 // Copyright (c) 2016 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 // String is an atomic type-safe wrapper around Value for strings.
  24 type String struct{ v Value }
  25
  26 // NewString creates a String.
  27 func NewString(str string) *String {
  28         s := &String{}
  29         if str != "" {
  30                 s.Store(str)
  31         }
  32         return s
  33 }
  34
  35 // Load atomically loads the wrapped string.
  36 func (s *String) Load() string {
  37         v := s.v.Load()
  38         if v == nil {
  39                 return ""
  40         }
  41         return v.(string)
  42 }
  43
  44 // Store atomically stores the passed string.
  45 // Note: Converting the string to an interface{} to store in the Value
  46 // requires an allocation.
  47 func (s *String) Store(str string) {
  48         s.v.Store(str)
  49 }