deferred

README

deferred

idea:

This is a tiny library that contains helpers to close any closer that returns error with defer.

The general idea is simple: make it with one line.

example:

    ...
    resp, err := http.Get("http://example.com/")
    if err != nil {
        // Handle error
    }

    defer deferred.CloseOrLog(resp.Body, logger)
    ...

list of methods:

// pass logger you use in your code
- CloseOrLog(cl io.Closer, log logger)  
- CloseOrLogCtx(ctx context.Context, cl io.Closer, log logger)

// only if you don't mind using standard log
- CloseOrLogStd(cl io.Closer)              
- CloseOrLogStdCtx(ctx context.Context, cl io.Closer)

Documentation

Overview

Package deferred provides helpers to close `io.Closer“. This helpers can be used as one-liner with defer keyword to call `Close` method and check error if occurs.

example: ```go

...
resp, err := http.Get("http://example.com/")
if err != nil {
    // Handle error
}

defer deferred.CloseOrLog(resp.Body, logger)
...

```

Index

• func CloseOrLog(cl io.Closer, log logger)
• func CloseOrLogCtx(ctx context.Context, cl closerWithContext, log logger)
• func CloseOrLogStd(cl io.Closer)
• func CloseOrLogStdCtx(ctx context.Context, cl closerWithContext)

Functions

func CloseOrLog

func CloseOrLog(cl io.Closer, log logger)

CloseOrLog tries to close `cl`. If error returned, log it. Supports loggers that have `Errorf` method. Like :

zap
logrus
apex/log
etc...

func CloseOrLogCtx

func CloseOrLogCtx(ctx context.Context, cl closerWithContext, log logger)

CloseOrLogCtx tries to close `cl`. If error returned, log it. Supports loggers that have `Errorf` method. Like :

zap
logrus
apex/log
etc...

func CloseOrLogStd

func CloseOrLogStd(cl io.Closer)

CloseOrLogStd tries to close `cl`. If error returned, log it with standard `log`.

func CloseOrLogStdCtx

func CloseOrLogStdCtx(ctx context.Context, cl closerWithContext)

CloseOrLogCtx tries to close `cl`. If error returned, log it with standard `log`.