Deprecated: install github.com/JosiahWitt/ensure/cmd/ensure instead.

exitcleanup

package

v0.1.5 Latest Latest Go to latest Published: Jan 17, 2022 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package exitcleanup provides helpers for running cleanups when the program is interrupted.

This section is empty.

This section is empty.

This section is empty.

type ExitCleaner interface {
	ToContext(ctx context.Context) context.Context
	Register(fn func() error)
}

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

ExitCleanup supports registering functions to be called when the program is interrupted.

func New(log *log.Logger) (*ExitCleanup, func())

New creates an ExitCleanup. It returns a cleanup function that should be called once right before exiting the app.

func (cleanup *ExitCleanup) Register(fn func() error)

Register a callback cleanup function.

func (cleanup *ExitCleanup) ToContext(ctx context.Context) context.Context

ToContext adds the ability to cancel the context. It should be used to wrap any contexts that are passed to functions that leverage Register().