💡 Atomic Boolean library for cleaner Go code, optimized for performance yet simple to use.
Go to file
barryz 42463bd9a0 atomically negates boolean value with Toggle method 2019-07-22 13:04:35 +08:00
.gitignore Initial commit 2016-05-25 11:28:42 +08:00
LICENSE Initial commit 2016-05-25 11:28:42 +08:00
README.md atomically negates boolean value with Toggle method 2019-07-22 13:04:35 +08:00
bool.go atomically negates boolean value with Toggle method 2019-07-22 13:04:35 +08:00
bool_test.go atomically negates boolean value with Toggle method 2019-07-22 13:04:35 +08:00

README.md

ABool 💡

Go Report Card GoDoc

Atomic Boolean library for Go, optimized for performance yet simple to use.

Use this for cleaner code.

Usage

import "github.com/tevino/abool"

cond := abool.New()  // default to false

cond.Set()                 // Set to true
cond.IsSet()               // Returns true
cond.UnSet()               // Set to false
cond.SetTo(true)           // Set to whatever you want
cond.SetToIf(false, true)  // Set to true if it is false, returns false(not set)
cond.Toggle() bool         // Toggle the boolean value atomically and returns the previous value.


// embedding
type Foo struct {
    cond *abool.AtomicBool  // always use pointer to avoid copy
}

Benchmark:

  • Go 1.6.2
  • OS X 10.11.4
# Read
BenchmarkMutexRead-4       	100000000	         21.0 ns/op
BenchmarkAtomicValueRead-4 	200000000	         6.30 ns/op
BenchmarkAtomicBoolRead-4  	300000000	         4.21 ns/op  # <--- This package

# Write
BenchmarkMutexWrite-4      	100000000	         21.6 ns/op
BenchmarkAtomicValueWrite-4	 30000000	         43.4 ns/op
BenchmarkAtomicBoolWrite-4 	200000000	         9.87 ns/op  # <--- This package

# CAS
BenchmarkMutexCAS-4        	 30000000	         44.9 ns/op
BenchmarkAtomicBoolCAS-4   	100000000	         11.7 ns/op  # <--- This package

# Toggle
BenchmarkMutexToggle-4       50000000            30.7 ns/op
BenchmarkAtomicBoolToggle-4  300000000           5.27 ns/op  # <--- This package