ignore

README

ignore

Ignore unimportant error values

Project Overview

Module github.com/shoenig/ignore provides a package with functions for ignoring unimportant error values. These are useful for indicating errors that do not matter, while also getting your IDE to stop highlighting ignored error returns.

Getting Started

The ignore package can be installed by running

go get github.com/shoenig/ignore

Example Usage of ignore

// Close, the old way
// _ = closer.Close()

// Close, the new way
ignore.Close(closer)

// Drain, the old way
// _, _ = io.Copy(io.Discard, reader)
// _ = reader.Close()

// Drain, the new way
ignore.Drain(reader)

Contributing

The github.com/shoenig/ignore module is always improving with new features and error corrections. For contributing bug fixes and new features please file an issue.

License

The github.com/shoenig/ignore module is open source under the BSD-3-Clause license.

Documentation

Overview

Package ignore is used to ignore unimportant errors.

Index

• func Close(c io.Closer)
• func Drain(rc io.ReadCloser)
• func Error(_ error)
• func Panic(err error)
• func Rollback(r Rollbacker)
• type Rollbacker

Functions

func Close

func Close(c io.Closer)

Close c and ignore the error.

func Drain

func Drain(rc io.ReadCloser)

Drain rc and Close it, ignoring any error.

func Error

func Error(_ error)

Error will ignore the error

func Panic

func Panic(err error)

Panic will cause a panic if the error is not nil.

Intended to pave over cases where an error "cannot" happen. e.g. JSON decoding a string literal - if an error occurs, something is seriously broken and the program may as well halt.

func Rollback

func Rollback(r Rollbacker)

Rollback r and ignore the error.

Types

type Rollbacker

type Rollbacker interface {
	Rollback() error
}

A Rollbacker implements the Rollback method.