exitcleanup

Documentation

Overview

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

Index

• type ExitCleaner
• type ExitCleanup
  • func New(log *log.Logger) (*ExitCleanup, func())
  • func (cleanup *ExitCleanup) Register(fn func() error)
  • func (cleanup *ExitCleanup) ToContext(ctx context.Context) context.Context

Types

type ExitCleaner

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

type ExitCleanup

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

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

func New

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 (*ExitCleanup) Register

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

Register a callback cleanup function.

func (*ExitCleanup) ToContext

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().