errors

Documentation

Overview

Package errors provides custom error types used within restic.

Index

• Variables
• func Cause(err error) error
• func Fatal(s string) error
• func Fatalf(s string, data ...interface{}) error
• func Is(x, y error) bool
• func IsFatal(err error) bool
• type Fataler

Variables

var Errorf = errors.Errorf

Errorf creates an error based on a format string and values. Wrapped so that this package does not appear in the stack trace.

var New = errors.New

New creates a new error based on message. Wrapped so that this package does not appear in the stack trace.

var WithMessage = errors.WithMessage

WithMessage annotates err with a new message. If err is nil, WithMessage returns nil.

var WithStack = errors.WithStack

var Wrap = errors.Wrap

Wrap wraps an error retrieved from outside of restic. Wrapped so that this package does not appear in the stack trace.

var Wrapf = errors.Wrapf

Wrapf returns an error annotating err with the format specifier. If err is nil, Wrapf returns nil.

Functions

func Cause

func Cause(err error) error

Cause returns the cause of an error. It will also unwrap certain errors, e.g. *url.Error returned by the net/http client.

func Fatal

func Fatal(s string) error

Fatal returns a wrapped error which implements the Fataler interface.

func Fatalf

func Fatalf(s string, data ...interface{}) error

Fatalf returns an error which implements the Fataler interface.

func Is

func Is(x, y error) bool

func IsFatal

func IsFatal(err error) bool

IsFatal returns true if err is a fatal message that should be printed to the user. Then, the program should exit.

Types

type Fataler

type Fataler interface {
	Fatal() bool
}

Fataler is an error which should be printed to the user directly. Afterwards, the program should exit with an error.