errutil

Documentation

Index

• Constants
• func Check(err error)
• func ErrAlreadyExists(description, filename string, location Location)
• func ErrNotFound(filename string, location Location)
• func Exit(code int)
• func RetryOnFailure(msg string, toRun func() bool) (ok bool)
• type Location

Constants

const (
	// RetryLimit is a number how many times bucket creation is retried before returning an error.
	RetryLimit = 3
)

Functions

func Check

func Check(err error)

Check checks if an error is present. If it is present, it displays the error and exits with status 1. If you want to display a custom message use CheckWithMessage.

func ErrAlreadyExists

func ErrAlreadyExists(description, filename string, location Location)

ErrAlreadyExists is called in case of a file conflict.

func ErrNotFound

func ErrNotFound(filename string, location Location)

ErrNotFound is called when a source copied from doesn't exists.

func Exit

func Exit(code int)

Exit quits the application with a given value.

func RetryOnFailure

func RetryOnFailure(msg string, toRun func() bool) (ok bool)

RetryOnFailure calls the given function for a certain (RetryLimit) number of times. The function should be an inline function, so it can set return values. The function returns an error. The retries stop, if the result is ok. After the certain number of times expired, it logs the error anyway.

Types

type Location

type Location int

Location is an enum for choosing between local file system of Google Cloud Storage.

const (
	// Lfs is the local file system enum value.
	Lfs Location = iota
	// Gcs is the Google Cloud Storage enum value.
	Gcs
)