validation

Documentation

Index

• Constants
• func NewProvider() gapp.Provider
• type Parser
  • func NewParser(strategy ParserStrategy) (Parser, error)
• type ParserStrategy
  • func NewParserStrategy(translator ut.Translator) (ParserStrategy, error)
• type Validator
  • func NewValidator(validate *validator.Validate, parser Parser) (Validator, error)

Constants

const (
	// ContainerID defines the id to be used as the container
	// registration id of a validation instance, and as a base id of all other
	// validation package instances registered in the application container.
	ContainerID = gapp.ContainerID + ".validation"

	// ContainerParserID defines the id to be used
	// as the container registration id of an error parser instance.
	ContainerParserID = ContainerID + ".parser"
)

Functions

func NewProvider

func NewProvider() gapp.Provider

NewProvider will create a new validation provider instance

Types

type Parser

type Parser interface {
	Parse(ctx *gin.Context, val interface{}, errs validator.ValidationErrors) (envelope.Envelope, error)
}

Parser defines the interface to an error parsing class used to convert a validation error into an envelope error

func NewParser

func NewParser(strategy ParserStrategy) (Parser, error)

NewParser instantiate a new validation parser instance

type ParserStrategy

type ParserStrategy func(ctx *gin.Context, val interface{}, err validator.FieldError) (envelope.Error, error)

ParserStrategy is a function type used to define a calling interface of a function responsible to parse a validation error into an envelope error information

func NewParserStrategy

func NewParserStrategy(translator ut.Translator) (ParserStrategy, error)

NewParserStrategy instantiate a new default error parser strategy used by the parser to convert a validation error into an envelope error

type Validator

type Validator func(ctx *gin.Context, val interface{}) (envelope.Envelope, error)

Validator is a function type used to define a calling interface of function responsible to validate an instance of a structure and return an initialized response envelope with the founded errors

func NewValidator

func NewValidator(validate *validator.Validate, parser Parser) (Validator, error)

NewValidator instantiates a new validation function