Categorygo.uber.org/atomic
modulepackage
1.11.0
Repository: https://github.com/uber-go/atomic.git
Documentation: pkg.go.dev

# README

atomic GoDoc Build Status Coverage Status Go Report Card

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/[email protected]

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.

# Functions

NewBool creates a new Bool.
NewDuration creates a new Duration.
NewError creates a new Error.
NewFloat32 creates a new Float32.
NewFloat64 creates a new Float64.
NewInt32 creates a new Int32.
NewInt64 creates a new Int64.
NewPointer creates a new Pointer.
NewString creates a new String.
NewTime creates a new Time.
NewUint32 creates a new Uint32.
NewUint64 creates a new Uint64.
NewUintptr creates a new Uintptr.
NewUnsafePointer creates a new UnsafePointer.

# Structs

Bool is an atomic type-safe wrapper for bool values.
Duration is an atomic type-safe wrapper for time.Duration values.
Error is an atomic type-safe wrapper for error values.
Float32 is an atomic type-safe wrapper for float32 values.
Float64 is an atomic type-safe wrapper for float64 values.
Int32 is an atomic wrapper around int32.
Int64 is an atomic wrapper around int64.
Pointer is an atomic pointer of type *T.
String is an atomic type-safe wrapper for string values.
Time is an atomic type-safe wrapper for time.Time values.
Uint32 is an atomic wrapper around uint32.
Uint64 is an atomic wrapper around uint64.
Uintptr is an atomic wrapper around uintptr.
UnsafePointer is an atomic wrapper around unsafe.Pointer.
Value shadows the type of the same name from sync/atomic https://godoc.org/sync/atomic#Value.