errutil

Documentation

Overview

Package errutil provides utility functions to handle errors.

Index

• func JoinFnError(err *error, fn ErrorFunc)
• func Trace(err error) error
• type ErrorFunc

Examples

• JoinFnError
• Trace

Functions

func JoinFnError

func JoinFnError(err *error, fn ErrorFunc)

JoinFnError appends the error returned by fn to the error pointed to by err.

Example

package main

import (
	"errors"
	"fmt"

	"github.com/tecnickcom/gogen/pkg/errutil"
)

func main() {
	err := errors.New("original error")

	fn := func() error {
		return errors.New("function error")
	}

	errutil.JoinFnError(&err, fn)

	fmt.Println(err)

}

Output:

original error
function error

func Trace

func Trace(err error) error

Trace annotates the error message with the filename, line number, and function name.

Example

package main

import (
	"errors"
	"fmt"

	"github.com/tecnickcom/gogen/pkg/errutil"
)

func main() {
	err := errors.New("example error")
	testErr := errutil.Trace(err)

	fmt.Println(testErr)
}

Types

type ErrorFunc

type ErrorFunc func() error

ErrorFunc is a function type that returns an error.