atm

Documentation

Overview

Package atm provides a collection of thread-safe types.

Index

• type Bool
  • func NewBool(in bool) Bool
  • func NewBoolRef(in bool) *Bool
  • func (b *Bool) IsFalse() bool
  • func (b *Bool) IsTrue() bool
  • func (b *Bool) Load() bool
  • func (b *Bool) SetFalse()
  • func (b *Bool) SetTrue()
  • func (b *Bool) Store(val bool)

Types

type Bool

type Bool uint32

Bool provides an atomic boolean value.

func NewBool

func NewBool(in bool) Bool

NewBool returns a Bool set to the provided starting value.

func NewBoolRef

func NewBoolRef(in bool) *Bool

NewBoolRef returns a reference to a Bool set to the provided starting value.

func (*Bool) IsFalse

func (b *Bool) IsFalse() bool

IsFalse returns false if the value is false.

func (*Bool) IsTrue

func (b *Bool) IsTrue() bool

IsTrue returns true if the value is true.

func (*Bool) Load

func (b *Bool) Load() bool

Load returns a bool representing the value.

func (*Bool) SetFalse

func (b *Bool) SetFalse()

SetFalse sets the Bool to false.

func (*Bool) SetTrue

func (b *Bool) SetTrue()

SetTrue sets the Bool to true.

func (*Bool) Store

func (b *Bool) Store(val bool)

Store sets the Bool based on the supplied bool value.