re
/
abool
forked from mirror/abool
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update usage

This commit is contained in:
Tevin Zhang 2020-07-16 13:35:52 +08:00
parent d174386fab
commit 8ad37317dc
No known key found for this signature in database
GPG Key ID: EE7DA2A50F0960FB
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -12,14 +12,14 @@ Use this for cleaner code.
```go
import "github.com/tevino/abool"
cond := abool.New() // default to false
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() *AtomicBool // Negates boolean atomically and returns a new AtomicBool object which holds previous boolean value.
cond.Set() // Set to true
cond.IsSet() // Returns true
cond.UnSet() // Set to false
cond.SetTo(any) // Set to whatever you want
cond.SetToIf(new, old) // Sets to `new` only if the Boolean matches the `old`, returns whether succeeded
cond.Toggle() // Inverts the boolean then returns the value before inverting
// embedding