sync

package module
Version: v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2021 License: BSD-3-Clause Imports: 2 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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)

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

var once Once

if once.Do(f) is called multiple times, f will be invoked until first successful execution. A new instance of Once is required for each function to execute.

Do is intended for initialization that must be run exactly once successfully.

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 successfully; future calls of Do return without calling f.

This is an adaptation from https://golang.org/pkg/sync/#Once

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL