errors

package

v1.0.1 Latest Latest Go to latest Published: Oct 5, 2021 License: MIT Imports: 2 Imported by: 0

Details

This section is empty.

This section is empty.

func IsValidation(err error) bool

IsValidation returns true if the error is a validation error.

func WriteResponse(w http.ResponseWriter, err error)

WriteResponse writes the instance of error to the response. This results in all errors being returned in a standard structure.

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

Error is a custom implementation of error, providing an error type and HTTP status code.

func New(err string) *Error

New returns a new instance of Error, with the given error message.

func NewValidation(err string) *Error

NewValidation returns a new instance of Error, with the typ "Validation".

func (err *Error) Error() string

Error returns the error message.

func (err *Error) MarshalJSON() ([]byte, error)

MarshalJSON is a custom JSON marshal func used when writing the error to a http.ResponseWriter.

func (err *Error) ParamName() *string

ParamName returns the error's paramName.

func (err *Error) SetParamName(name string) *Error

SetParamName sets the error's paramName property.

func (err *Error) SetStatus(statusCode int) *Error

SetStatus sets the status code of the error - this is used for the HTTP response.

func (err *Error) SetType(typ string) *Error

SetType sets the type of the error - this is used for the HTTP response.

func (err *Error) Status() int

Status returns the error status code.