validation

Documentation

Index

• func AddPrefix(fieldPrefix string, err error) error
• func IsClientError(err error) bool
• func IsValidationError(err error) bool
• func NewGenericError(message string) error
• func WrapError(err error) error
• type FieldError
  • func NewFieldError(fieldName string, reason string) FieldError
  • func NewFieldErrorf(fieldName string, reasonFormat string, args ...interface{}) FieldError
• type MultiFieldError
  • func NewMultiFieldError(errs []FieldError) MultiFieldError

Functions

func AddPrefix

func AddPrefix(fieldPrefix string, err error) error

AddPrefix will prepend a prefix to all field names within the given error.

func IsClientError

func IsClientError(err error) bool

IsClientError will determine if an error's cause is due to request/client error.

func IsValidationError

func IsValidationError(err error) bool

IsValidationError will determine if an error's cause is a field validation error.

func NewGenericError

func NewGenericError(message string) error

NewGenericError will create a new generic validation error.

func WrapError

func WrapError(err error) error

WrapError will return a new error that is reported as a ClientError.

Types

type FieldError

type FieldError interface {
	error
	Validation() bool
	Field() string
	Reason() string
}

A FieldError represents an invalid field during validation.

func NewFieldError

func NewFieldError(fieldName string, reason string) FieldError

NewFieldError will create a new FieldError for the given field and reason

func NewFieldErrorf

func NewFieldErrorf(fieldName string, reasonFormat string, args ...interface{}) FieldError

NewFieldError will create a new FieldError for the given field and reason

type MultiFieldError

type MultiFieldError interface {
	error
	Validation() bool
	FieldErrors() []FieldError
}

func NewMultiFieldError

func NewMultiFieldError(errs []FieldError) MultiFieldError

NewMultiFieldError will combine multiple FieldErrors into a MultiFieldError.