quiet

package

v0.10.2 Latest Latest Go to latest Published: Dec 31, 2024 License: MIT Imports: 3 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tomcz/gotools

Links

Open Source Insights

README ¶

quiet

Quiet cleanup functions for graceful shutdowns.

Documentation ¶

Index ¶

func Close(closer io.Closer)
func CloseFunc(close func())
func CloseFuncE(close func() error)
func CloseWithTimeout(close func(ctx context.Context) error, timeout time.Duration)
func Noop() io.Closer
func SetLogger(logger Logger)
type Closer
type Logger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Close ¶

func Close(closer io.Closer)

Close quietly invokes the closer. Any errors or panics will be logged by the package logger.

func CloseFunc ¶

func CloseFunc(close func())

CloseFunc quietly invokes the given function. Any panics will be logged by the package logger.

func CloseFuncE ¶

func CloseFuncE(close func() error)

CloseFuncE quietly invokes the given function. Any errors or panics will be logged by the package logger.

func CloseWithTimeout ¶

func CloseWithTimeout(close func(ctx context.Context) error, timeout time.Duration)

CloseWithTimeout provides a closer for graceful service shutdown. Any errors or panics will be logged by the package logger.

func Noop ¶ added in v0.7.0

func Noop() io.Closer

Noop returns a closer that does nothing.

func SetLogger ¶

func SetLogger(logger Logger)

SetLogger sets a panic & error logger for the package rather than the default noop logger. Passing in a nil logger will reset the package logger to default.

Types ¶

type Closer ¶

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

Closer for when you need to coordinate delayed cleanup.

func (*Closer) Add ¶

func (c *Closer) Add(closers ...io.Closer)

Add multiple closers to be invoked by CloseAll.

func (*Closer) AddFunc ¶

func (c *Closer) AddFunc(close func())

AddFunc adds a cleanup function to be invoked by CloseAll.

func (*Closer) AddFuncE ¶

func (c *Closer) AddFuncE(close func() error)

AddFuncE adds a cleanup function to be invoked by CloseAll.

func (*Closer) AddShutdown ¶ added in v0.7.0

func (c *Closer) AddShutdown(shutdown func(ctx context.Context) error, timeout time.Duration)

AddShutdown adds a shutdown function to be invoked by CloseAll.

func (*Closer) Close ¶

func (c *Closer) Close() error

Close for io.Closer compatibility. Calls CloseAll and returns nil.

func (*Closer) CloseAll ¶ added in v0.2.10

func (c *Closer) CloseAll()

CloseAll will call each closer in reverse order to addition. This mimics the invocation order of defers in a function.

type Logger ¶

type Logger interface {
	Error(err error)
	Panic(p any)
}

Logger allows logging of errors and panics.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL