validator

Documentation

Index

• Variables
• func CallValidatorIfExists(candidate interface{}) error
• func FieldError(fieldName string, err error) error
• func Trans(err error) string
• func Validate(obj interface{}) error
• type IValidator
• type StructValidator

Variables

var DefaultValidator = new(defaultValidator)

var (
	Validator *validator.Validate
)

Functions

func CallValidatorIfExists

func CallValidatorIfExists(candidate interface{}) error

func FieldError

func FieldError(fieldName string, err error) error

FieldError wraps a given Validator error providing a message call stack.

func Trans

func Trans(err error) string

func Validate

func Validate(obj interface{}) error

Types

type IValidator

type IValidator interface {
	Validate() error
}

Validator is a general interface that allows a message to be validated.

type StructValidator

type StructValidator interface {
	// ValidateStruct can receive any kind of type and it should never panic, even if the configuration is not right.
	// If the received type is not a struct, any validation should be skipped and nil must be returned.
	// If the received type is a struct or pointer to a struct, the validation should be performed.
	// If the struct is not valid or the validation itself fails, a descriptive error should be returned.
	// Otherwise nil must be returned.
	ValidateStruct(interface{}) error

	// Engine returns the underlying validator engine which powers the
	// StructValidator implementation.
	Engine() interface{}
}

StructValidator is the minimal interface which needs to be implemented in order for it to be used as the validator engine for ensuring the correctness of the request. Gin provides a default implementation for this using https://github.com/go-playground/validator/tree/v8.18.2.