closers

Documentation

Overview

Package closers contains utilities for dealing with io.Closer implementations

Index

• Variables
• func Close(c io.Closer)
• func CloseAll(cs ...io.Closer)
• func CloseFunc(fn func() error) io.Closer
• type MultiCloser
  • func (c *MultiCloser) Add(cl io.Closer)
  • func (c *MultiCloser) Close() error

Variables

var Noop io.Closer = &noopCloser{}

Noop is an io.Closer implementation that does nothing.

Functions

func Close

func Close(c io.Closer)

Close the given closer. If a non-nil error is returned, it is logged.

func CloseAll

func CloseAll(cs ...io.Closer)

CloseAll calls Close on all io.Closer implementations passed as arguments.

func CloseFunc

func CloseFunc(fn func() error) io.Closer

CloseFunc wraps te provider function as an io.Closer implementation. This can be used when you have a type that has some form of close method that does not directly implement io.Closer.

Types

type MultiCloser

type MultiCloser []io.Closer

The MultiCloser type is a collection of io.Closer implementations that can be collected and closed at once.

func (*MultiCloser) Add

func (c *MultiCloser) Add(cl io.Closer)

Add a closer to the MultiCloser. It will be closed when calling MultiCloser.Close.

func (*MultiCloser) Close

func (c *MultiCloser) Close() error

Close all io.Closer implementations in the MultiCloser. Returns any non-nil errors as a multi-error.