errors

Documentation

Overview

Package errors implements utilities to handle errors in koazee

Index

• type ErrCode
  • func (c ErrCode) String() string
• type Error
  • func EmptyStream(op string, msg string, args ...interface{}) *Error
  • func InvalidArgument(op string, msg string, args ...interface{}) *Error
  • func InvalidIndex(op string, msg string, args ...interface{}) *Error
  • func InvalidType(op string, msg string, args ...interface{}) *Error
  • func New(operation string, code ErrCode, msgFormat string, args ...interface{}) *Error
  • func UserError(op string, err error) *Error
  • func (e Error) Code() string
  • func (e Error) Error() string
  • func (e Error) Operation() string
  • func (e *Error) UserError() error
  • func (e Error) With(key string, value interface{}) Error

Types

type ErrCode

type ErrCode string

ErrCode type used to define the error codes in koazee

const ErrInvalidArgument ErrCode = "err.invalid-argument"

ErrInvalidArgument code for errors produced by an invalid input in the operation

const ErrInvalidIndex ErrCode = "err.invalid-index"

ErrInvalidIndex code for errors related to invalid index when accessing to a position in the stream

const ErrInvalidType ErrCode = "err.invalid-type"

ErrInvalidType code for errors related to invalid type

const ErrItemsNil ErrCode = "err.items-nil"

ErrItemsNil code for errors produced by a nil stream

const ErrUser ErrCode = "err.user-error"

ErrUser code for errors produced by the user's function

func (ErrCode) String

func (c ErrCode) String() string

String print string of error code

type Error

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

Error encapsulates error info

func EmptyStream

func EmptyStream(op string, msg string, args ...interface{}) *Error

EmptyStream creates an item nil error

func InvalidArgument

func InvalidArgument(op string, msg string, args ...interface{}) *Error

InvalidArgument creates a invalid argument error

func InvalidIndex

func InvalidIndex(op string, msg string, args ...interface{}) *Error

InvalidIndex creates a invalid index error

func InvalidType

func InvalidType(op string, msg string, args ...interface{}) *Error

InvalidType creates an invalid type error

func New

func New(operation string, code ErrCode, msgFormat string, args ...interface{}) *Error

New creates a new instance of Error

func UserError

func UserError(op string, err error) *Error

UserError creates a user error

func (Error) Code

func (e Error) Code() string

Code returns the code for the error

func (Error) Error

func (e Error) Error() string

Error converts the error into a readable message

func (Error) Operation

func (e Error) Operation() string

Operation returns the operation associated to the error

func (*Error) UserError

func (e *Error) UserError() error

UserError returns the error from the user's function, if any.

func (Error) With

func (e Error) With(key string, value interface{}) Error

With permits add extra info to show displayed when printing the error