errors

Documentation

Overview

Package errors contains errors used by the installer.

Index

• func ToJSON(err error) string
• func Wrap(errCode InstallerErrorCode, err error) error
• type InstallerError
  • func FromJSON(errStr string) *InstallerError
  • func (e InstallerError) Error() string
  • func (e InstallerError) Is(target error) bool
• type InstallerErrorCode
  • func GetCode(err error) InstallerErrorCode

Functions

func ToJSON

func ToJSON(err error) string

ToJSON returns the error as a JSON string.

func Wrap

func Wrap(errCode InstallerErrorCode, err error) error

Wrap wraps the given error with an installer error. If the given error is already an installer error, it is not wrapped and left as it is. Only the deepest InstallerError remains.

Types

type InstallerError

type InstallerError struct {
	// contains filtered or unexported fields
}

InstallerError is an error type used by the installer.

func FromJSON

func FromJSON(errStr string) *InstallerError

FromJSON returns an InstallerError from a JSON string.

func (InstallerError) Error

func (e InstallerError) Error() string

Error returns the error message.

func (InstallerError) Is

func (e InstallerError) Is(target error) bool

Is implements the Is method of the errors.Is interface.

type InstallerErrorCode

type InstallerErrorCode uint64

InstallerErrorCode is an error code used by the installer.

const (

	// ErrDownloadFailed is the code for a download failure.
	ErrDownloadFailed InstallerErrorCode = 1
	// ErrNotEnoughDiskSpace is the code for not enough disk space.
	ErrNotEnoughDiskSpace InstallerErrorCode = 2
	// ErrPackageNotFound is the code for a package not found.
	ErrPackageNotFound InstallerErrorCode = 3
	// ErrFilesystemIssue is the code for a filesystem issue (e.g. permission issue).
	ErrFilesystemIssue InstallerErrorCode = 4
)

func GetCode

func GetCode(err error) InstallerErrorCode

GetCode returns the installer error code of the given error.