wrap

README

wrap

Golang package to wrap things into a bit of context

Documentation

Overview

Package wrap contains code to simply wrap things into a bit of context.

Index

• func Error(err error, context string) error
• func Errorf(err error, format string, a ...interface{}) error
• func Errors(errs []error, context string) error
• func Errorsf(errors []error, format string, a ...interface{}) error
• type ContextError
• type ListOfErrors

Functions

func Error

func Error(err error, context string) error

Error creates an error with additional context

Deprecated: Use fmt.Errorf() instead using the `%w` format specifier.

func Errorf

func Errorf(err error, format string, a ...interface{}) error

Errorf creates an error with additional formatted context

Deprecated: Use fmt.Errorf() instead using the `%w` format specifier.

func Errors

func Errors(errs []error, context string) error

Errors creates a list of errors with additional context

Deprecated: Use fmt.Errorf() and errors.Join() instead.

func Errorsf

func Errorsf(errors []error, format string, a ...interface{}) error

Errorsf creates a list of errors with additional formatted context

Deprecated: Use fmt.Errorf() and errors.Join() instead.

Types

type ContextError

type ContextError interface {
	Context() string
	Cause() error
}

ContextError interface describes the simple type that is able to provide a textual context as well as the cause explaining the underlying error.

Deprecated: Discontinued, use fmt.Errorf() instead.

type ListOfErrors

type ListOfErrors interface {
	Context() string
	Errors() []error
}

ListOfErrors interface describes a list of errors with additional context information with an explanation.

Deprecated: Discontinued, use errors.Join() instead.