finalizer

package

v0.0.9 Latest Latest Go to latest Published: Mar 17, 2022 License: MIT Imports: 4 Imported by: 12

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

This section is empty.

This section is empty.

func NewContextCloser(cancel context.CancelFunc) io.Closer

NewContextCloser transforms context cancellation function to be used with finalizer.

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

ContextCloser maps a context to io.Closer.

func (cc ContextCloser) Close() error

Close the context.

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

Finalizer collects resources for convenient cleanup.

func NewFinalizer() *Finalizer

NewFinalizer returns a new Finalizer.

func (r *Finalizer) Add(cs ...io.Closer)

Add one or more io.Closer to the finalizer.

func (r *Finalizer) AddFn(fs ...func())

AddFn one or more func() to the finalizer.

func (r *Finalizer) Cleanup(err error) error

Cleanup closes all io.Closer and cancels all contexts with err.

func (r *Finalizer) Cleanupf(format string, err error) error

Cleanupf closes all io.Closer and cancels all contexts with a formatted err.