close

Documentation

Overview

Package close provides utilities for closing resources.

Index

• Variables
• func TryClose(r interface{}) error
• type Closer
• type CloserFn
  • func (fn CloserFn) Close() error
• type SimpleCloser
• type SimpleCloserFn
  • func (fn SimpleCloserFn) Close()

Variables

var (
	// ErrNotCloseable is returned when trying to close a resource
	// that does not conform to a closeable interface.
	ErrNotCloseable = errors.New("not a closeable resource")
)

Functions

func TryClose

func TryClose(r interface{}) error

TryClose attempts to close a resource, the resource is expected to implement either Closeable or CloseableResult.

Types

type Closer

type Closer interface {
	io.Closer
}

Closer is a resource that can be closed.

type CloserFn

type CloserFn func() error

CloserFn implements the SimpleCloser interface.

func (CloserFn) Close

func (fn CloserFn) Close() error

Close implements the SimplerCloser interface.

type SimpleCloser

type SimpleCloser interface {
	Close()
}

SimpleCloser is a resource that can be closed without returning a result.

type SimpleCloserFn

type SimpleCloserFn func()

SimpleCloserFn implements the SimpleCloser interface.

func (SimpleCloserFn) Close

func (fn SimpleCloserFn) Close()

Close implements the SimplerCloser interface.