validate

Documentation

Overview

Package validate contains the support for validating models.

Index

• func Check(val any) error
• func CheckID(id string) error
• func IsFieldErrors(err error) bool
• func NewFieldsError(field string, err error) error
• type FieldError
• type FieldErrors
  • func GetFieldErrors(err error) FieldErrors
  • func (fe FieldErrors) Error() string
  • func (fe FieldErrors) Fields() map[string]string

Functions

func Check

func Check(val any) error

Check validates the provided model against it's declared tags.

func CheckID

func CheckID(id string) error

func IsFieldErrors

func IsFieldErrors(err error) bool

IsFieldErrors checks if an error of type FieldErrors exists.

func NewFieldsError

func NewFieldsError(field string, err error) error

NewFieldsError creates an fields error.

Types

type FieldError

type FieldError struct {
	Field string `json:"field"`
	Err   string `json:"error"`
}

FieldError is used to indicate an error with a specific request field.

type FieldErrors

type FieldErrors []FieldError

FieldErrors represents a collection of field errors.

func GetFieldErrors

func GetFieldErrors(err error) FieldErrors

GetFieldErrors returns a copy of the FieldErrors pointer.

func (FieldErrors) Error

func (fe FieldErrors) Error() string

Error implements the error interface.

func (FieldErrors) Fields

func (fe FieldErrors) Fields() map[string]string

Fields returns the fields that failed validation.