cmd/bpa-operator/vendor/go.uber.org/atomic/README.md

   1 # atomic [![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Go Report Card][reportcard-img]][reportcard]
   2
   3 Simple wrappers for primitive types to enforce atomic access.
   4
   5 ## Installation
   6 `go get -u go.uber.org/atomic`
   7
   8 ## Usage
   9 The standard library's `sync/atomic` is powerful, but it's easy to forget which
  10 variables must be accessed atomically. `go.uber.org/atomic` preserves all the
  11 functionality of the standard library, but wraps the primitive types to
  12 provide a safer, more convenient API.
  13
  14 ```go
  15 var atom atomic.Uint32
  16 atom.Store(42)
  17 atom.Sub(2)
  18 atom.CAS(40, 11)
  19 ```
  20
  21 See the [documentation][doc] for a complete API specification.
  22
  23 ## Development Status
  24 Stable.
  25
  26 <hr>
  27 Released under the [MIT License](LICENSE.txt).
  28
  29 [doc-img]: https://godoc.org/github.com/uber-go/atomic?status.svg
  30 [doc]: https://godoc.org/go.uber.org/atomic
  31 [ci-img]: https://travis-ci.org/uber-go/atomic.svg?branch=master
  32 [ci]: https://travis-ci.org/uber-go/atomic
  33 [cov-img]: https://codecov.io/gh/uber-go/atomic/branch/master/graph/badge.svg
  34 [cov]: https://codecov.io/gh/uber-go/atomic
  35 [reportcard-img]: https://goreportcard.com/badge/go.uber.org/atomic
  36 [reportcard]: https://goreportcard.com/report/go.uber.org/atomic