README
¶
atomic 
Simple wrappers for primitive types to enforce atomic access.
Installation
$ go get -u go.uber.org/atomic@v1
Legacy Import Path
As of v1.5.0, the import path go.uber.org/atomic is the only supported way
of using this package. If you are using Go modules, this package will fail to
compile with the legacy import path path github.com/uber-go/atomic.
We recommend migrating your code to the new import path but if you're unable
to do so, or if your dependencies are still using the old import path, you
will have to add a replace directive to your go.mod file downgrading the
legacy import path to an older version.
replace github.com/uber-go/atomic => github.com/uber-go/atomic v1.4.0
You can do so automatically by running the following command.
$ go mod edit -replace github.com/uber-go/atomic=github.com/uber-go/atomic@v1.4.0
Usage
The standard library's sync/atomic is powerful, but it's easy to forget which
variables must be accessed atomically. go.uber.org/atomic preserves all the
functionality of the standard library, but wraps the primitive types to
provide a safer, more convenient API.
var atom atomic.Uint32
atom.Store(42)
atom.Sub(2)
atom.CAS(40, 11)
See the documentation for a complete API specification.
Development Status
Stable.
Released under the MIT License.
Documentation
¶
Index ¶
- type Bool
- type Duration
- func (d *Duration) Add(n time.Duration) time.Duration
- func (d *Duration) CAS(o, n time.Duration) bool
- func (d *Duration) Load() time.Duration
- func (d *Duration) Store(v time.Duration)
- func (d *Duration) String() string
- func (d *Duration) Sub(n time.Duration) time.Duration
- func (d *Duration) Swap(o time.Duration) time.Duration
- type Error
- type Int32
- type Int64
- type String
- type Uint32
- func (i *Uint32) Add(n uint32) uint32
- func (i *Uint32) CAS(old, new uint32) bool
- func (i *Uint32) Dec() uint32
- func (i *Uint32) Inc() uint32
- func (i *Uint32) Load() uint32
- func (i *Uint32) Store(n uint32)
- func (i *Uint32) String() string
- func (i *Uint32) Sub(n uint32) uint32
- func (i *Uint32) Swap(n uint32) uint32
- type Uint64
- func (i *Uint64) Add(n uint64) uint64
- func (i *Uint64) CAS(old, new uint64) bool
- func (i *Uint64) Dec() uint64
- func (i *Uint64) Inc() uint64
- func (i *Uint64) Load() uint64
- func (i *Uint64) MarshalJSON() ([]byte, error)
- func (i *Uint64) Store(n uint64)
- func (i *Uint64) String() string
- func (i *Uint64) Sub(n uint64) uint64
- func (i *Uint64) Swap(n uint64) uint64
- func (i *Uint64) UnmarshalJSON(b []byte) error
- type Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Bool ¶
type Bool struct {
// contains filtered or unexported fields
}
Bool is an atomic type-safe wrapper for bool values.
type Duration ¶
type Duration struct {
// contains filtered or unexported fields
}
Duration is an atomic type-safe wrapper for time.Duration values.
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is an atomic type-safe wrapper for error values.
type Int32 ¶
type Int32 struct {
// contains filtered or unexported fields
}
Int32 is an atomic wrapper around int32.
type Int64 ¶
type Int64 struct {
// contains filtered or unexported fields
}
Int64 is an atomic wrapper around int64.
type String ¶
type String struct {
// contains filtered or unexported fields
}
String is an atomic type-safe wrapper for string values.
type Uint32 ¶
type Uint32 struct {
// contains filtered or unexported fields
}
Uint32 is an atomic wrapper around uint32.
type Uint64 ¶
type Uint64 struct {
// contains filtered or unexported fields
}
Uint64 is an atomic wrapper around uint64.
func (*Uint64) MarshalJSON ¶
MarshalJSON encodes the wrapped uint64 into JSON.
func (*Uint64) UnmarshalJSON ¶
UnmarshalJSON decodes JSON into the wrapped uint64.
type Value ¶
Value shadows the type of the same name from sync/atomic https://godoc.org/sync/atomic#Value
Source Files