closeflag

Documentation

Index

• Variables
• type CloseFlag
  • func (c *CloseFlag) Chan() <-chan (struct{})
  • func (c *CloseFlag) Close() error
  • func (c *CloseFlag) IsClosed() bool

Variables

var (
	// ErrorClosed is returned when the object is closed multiple times
	ErrorClosed = errors.New("CloseFlag was already closed. This is harmless.")
)

Types

type CloseFlag

type CloseFlag struct {

	// CloseFunc will be called the first time Close is called. It is allowed to call Close itself
	CloseFunc func() error
	// contains filtered or unexported fields
}

CloseFlag is a simple object that has a close function that closes a channel and can be called many times

func (*CloseFlag) Chan

func (c *CloseFlag) Chan() <-chan (struct{})

Chan returns a channel that will be closed upon closing the CloseFlag

func (*CloseFlag) Close

func (c *CloseFlag) Close() error

Close closes the CloseFlag. It can safely be called multiple times

func (*CloseFlag) IsClosed

func (c *CloseFlag) IsClosed() bool

IsClosed returns if the flag was already closed