sync

Documentation

Index

• type Once
  • func (o *Once) Do(f func() error) error
  • func (o *Once) Done() bool

Types

type Once

type Once struct {
	// contains filtered or unexported fields
}

Once is an object that will perform exactly one action.

A Once must not be copied after first use.

func (*Once) Do

func (o *Once) Do(f func() error) error

Do calls the function f if and only if Do is being called for the first time for this instance of Once. In other words, given

var once Once

if once.Do(f) is called multiple times, only the first call will invoke f, even if f has a different value in each invocation. A new instance of Once is required for each function to execute.

Do is intended for initialization that must be run exactly once. Since f is niladic, it may be necessary to use a function literal to capture the arguments to a function to be invoked by Do:

config.once.Do(func() { config.init(filename) })

Because no call to Do returns until the one call to f returns, if f causes Do to be called, it will deadlock.

If f panics, Do considers it to have returned; future calls of Do return without calling f.

func (*Once) Done

func (o *Once) Done() bool