vFile

Documentation

Overview

File Validators

Index

• Constants
• func Must(file *multipart.FileHeader, err error) *multipart.FileHeader
• func MustMultiple(files []*multipart.FileHeader, err error) []*multipart.FileHeader
• func Validate(file *multipart.FileHeader, rules ...ValidationRule) (*multipart.FileHeader, error)
• func ValidateMultiple(files []*multipart.FileHeader, rules ...ValidationRule) ([]*multipart.FileHeader, error)
• type ValidationRule
  • func AcceptMime(mimes ...string) ValidationRule
  • func Mandatory() ValidationRule
  • func MaxSize(maxBytes int64) ValidationRule
  • func Optional(rules ...ValidationRule) ValidationRule
  • func OverrideErrorMsg(validationError vError.ValidationError, rules ...ValidationRule) ValidationRule

Constants

const (
	Type = "file"

	MandatoryErrorFormat  = "File is required."
	AcceptMimeErrorFormat = "Invalid Type, must be '{{.mimes|join \"or\"}}'."
	MaxSizeErrorFormat    = "File size should not be bigger than {{.maxBytes}}."
)

Functions

func Must

func Must(file *multipart.FileHeader, err error) *multipart.FileHeader

func MustMultiple

func MustMultiple(files []*multipart.FileHeader, err error) []*multipart.FileHeader

func Validate

func Validate(file *multipart.FileHeader, rules ...ValidationRule) (*multipart.FileHeader, error)

func ValidateMultiple

func ValidateMultiple(files []*multipart.FileHeader, rules ...ValidationRule) ([]*multipart.FileHeader, error)

Types

type ValidationRule

type ValidationRule func(value *multipart.FileHeader, hasError bool) error

func AcceptMime

func AcceptMime(mimes ...string) ValidationRule

Validate Content Type by list of mime

func Mandatory

func Mandatory() ValidationRule

Make sure value is set, if not set the rule return a validation error

func MaxSize

func MaxSize(maxBytes int64) ValidationRule

Validate date by file size.

func Optional

func Optional(rules ...ValidationRule) ValidationRule

Optional Value, if value is not set, return nil, otherwise go though the validation rules.

func OverrideErrorMsg

func OverrideErrorMsg(validationError vError.ValidationError, rules ...ValidationRule) ValidationRule

Override Error Message