You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

string_ext.go 1.7KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. // 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. package atomic
  21. //go:generate bin/gen-atomicwrapper -name=String -type=string -wrapped=Value -file=string.go
  22. // String returns the wrapped value.
  23. func (s *String) String() string {
  24. return s.Load()
  25. }
  26. // MarshalText encodes the wrapped string into a textual form.
  27. //
  28. // This makes it encodable as JSON, YAML, XML, and more.
  29. func (s *String) MarshalText() ([]byte, error) {
  30. return []byte(s.Load()), nil
  31. }
  32. // UnmarshalText decodes text and replaces the wrapped string with it.
  33. //
  34. // This makes it decodable from JSON, YAML, XML, and more.
  35. func (s *String) UnmarshalText(b []byte) error {
  36. s.Store(string(b))
  37. return nil
  38. }