validate

Documentation

Index

• Variables
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Field() string
  • func (e *Error) Unwrap() error
• type StringValidator
  • func (v StringValidator) Validate(s string) *Error
• type StringValidatorFunc
  • func SpecialCharWhitelist(name string, exceptions ...rune) StringValidatorFunc
  • func StringContainsDigits(name string, n int) StringValidatorFunc
  • func StringContainsSpecialChars(name string, n int) StringValidatorFunc
  • func StringMaxLength(name string, n int) StringValidatorFunc
  • func StringMinLength(name string, n int) StringValidatorFunc
• type UUIDValidator
  • func (v UUIDValidator) Validate(s uuid.UUID) *Error
• type UUIDValidatorFunc
  • func UUIDIsNotNil(name string) UUIDValidatorFunc

Variables

var (
	ErrStringMinLength            = errors.New("string is too short")
	ErrStringMaxLength            = errors.New("string is too long")
	ErrStringContainsSpecialChars = errors.New("string does not contain enough special characters")
	ErrStringContainsDigits       = errors.New("string does not contain enough digits")
	ErrSpecialCharWhitelist       = errors.New("string contains invalid characters")
)

var (
	ErrUUIDIsNil = errors.New("uuid is nil")
)

Types

type Error

type Error struct {
	Message string // Message with details about the error.
	// contains filtered or unexported fields
}

Error is a validation error.

func (*Error) Error

func (e *Error) Error() string

Error returns the error message.

func (*Error) Field

func (e *Error) Field() string

Field returns the field that caused the error.

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns the wrapped error.

type StringValidator

type StringValidator []StringValidatorFunc

StringValidator is a list of StringValidatorFunc.

func (StringValidator) Validate

func (v StringValidator) Validate(s string) *Error

type StringValidatorFunc

type StringValidatorFunc func(string) *Error

StringValidatorFunc is a function that validates a string.

func SpecialCharWhitelist

func SpecialCharWhitelist(name string, exceptions ...rune) StringValidatorFunc

SpecialCharWhitelist returns a StringValidatorFunc that checks if a string contains only letters, digits, and exceptions.

func StringContainsDigits

func StringContainsDigits(name string, n int) StringValidatorFunc

StringContainsDigits returns a StringValidatorFunc that checks if a string contains n digits.

func StringContainsSpecialChars

func StringContainsSpecialChars(name string, n int) StringValidatorFunc

StringContainsSpecialChars returns a StringValidatorFunc that checks if a string contains n special characters.

func StringMaxLength

func StringMaxLength(name string, n int) StringValidatorFunc

StringMaxLength returns a StringValidatorFunc that checks if a string is at most n characters long.

func StringMinLength

func StringMinLength(name string, n int) StringValidatorFunc

StringMinLength returns a StringValidatorFunc that checks if a string is at least n characters long.

type UUIDValidator

type UUIDValidator []UUIDValidatorFunc

UUIDValidator is a list of UUIDValidatorFunc.

func (UUIDValidator) Validate

func (v UUIDValidator) Validate(s uuid.UUID) *Error

type UUIDValidatorFunc

type UUIDValidatorFunc func(uuid.UUID) *Error

UUIDValidatorFunc is a function that validates a UUID.

func UUIDIsNotNil

func UUIDIsNotNil(name string) UUIDValidatorFunc

UUIDIsNotNil validates that a UUID is not nil.