validate

Documentation

Index

• Constants
• func IsMemberOf(claim string, claims ...string) bool
• func NotEmpty(claims ...string) bool
• type Assertion
• type Validatable
• type Validator
  • func New(name string) *Validator
  • func (v *Validator) AddError(txt string)
  • func (v *Validator) AddWarning(txt string)
  • func (v *Validator) AsError() error
  • func (v *Validator) Error() string
  • func (v *Validator) ISO639(src string)
  • func (v *Validator) IsClean() bool
  • func (v *Validator) IsValid() bool
  • func (v *Validator) MapContains(src map[string]string, key, name string)
  • func (v *Validator) MapNotEmpty(src map[string]string, name string)
  • func (v *Validator) NErrors() int
  • func (v *Validator) NWarnings() int
  • func (v *Validator) NonZero(src int, name string)
  • func (v *Validator) NotNil(src interface{})
  • func (v *Validator) RFC1123Z(src string)
  • func (v *Validator) Report() string
  • func (v *Validator) StringEquals(src, expected string)
  • func (v *Validator) StringNotEmpty(src, name string)
  • func (v *Validator) Timestamp(src string)
  • func (v *Validator) Validate(src Validatable) *Validator

Constants

const (
	// AssertionWarning indicates a potential issue
	AssertionWarning = 0
	// AssertionError indicates an error in the validation
	AssertionError = 1

	MsgStringMismatch      = "expected '%s', found '%s'"
	MsgNonEmptyString      = "expected non empty string '%s'"
	MsgNotNil              = "expected not-nil attribute, got '%s'"
	MsgNonZero             = "expected non-zero value '%s'"
	MsgInvalidLanguageCode = "invalid language code '%s'"
	MsgInvalidTimestamp    = "invalid timestamp '%d'"
	MsgNonEmptyMap         = "expected none empty map '%s'"
	MsgExpectedKey         = "expected key '%s' in map '%s'"
	MsgEmptyReport         = "validation '%s' has zero errors/warnings"
)

Functions

func IsMemberOf

func IsMemberOf(claim string, claims ...string) bool

IsMemberOf returns true if claim is part of the list of claims

func NotEmpty

func NotEmpty(claims ...string) bool

NotEmpty test all provided values to be not empty

Types

type Assertion

type Assertion struct {
	Type int    // 0 == warning, 1 == error
	Txt  string // description of the problem
	Err  error
}

Assertion is used to collect validation information

type Validatable

type Validatable interface {
	Validate(*Validator) *Validator
}

Validatable is the interface that maust be implemented to support recursive validations of strucs

type Validator

type Validator struct {
	Name     string
	Issues   []*Assertion
	Errors   int
	Warnings int
}

Validator collects assertions

func New

func New(name string) *Validator

New initializes and returns a new Validator

func (*Validator) AddError

func (v *Validator) AddError(txt string)

AddError adds an error assertion

func (*Validator) AddWarning

func (v *Validator) AddWarning(txt string)

AddWarning adds an warning assertion

func (*Validator) AsError

func (v *Validator) AsError() error

AsError returns an error if NError > 0, nil otherwise

func (*Validator) Error

func (v *Validator) Error() string

Error returns an error text

func (*Validator) ISO639

func (v *Validator) ISO639(src string)

ISO639 verifies that src complies with ISO 639-1

func (*Validator) IsClean

func (v *Validator) IsClean() bool

IsClean returns true if NError == 0 AND NWarnings == 0

func (*Validator) IsValid

func (v *Validator) IsValid() bool

IsValid returns true if NError == 0. Warnings are ignored

func (*Validator) MapContains

func (v *Validator) MapContains(src map[string]string, key, name string)

MapContains verifies that a map contains key

func (*Validator) MapNotEmpty

func (v *Validator) MapNotEmpty(src map[string]string, name string)

MapNotEmpty verifies that a map is not empty

func (*Validator) NErrors

func (v *Validator) NErrors() int

NErrors returns the number of erros

func (*Validator) NWarnings

func (v *Validator) NWarnings() int

NWarnings returns the number of warnings

func (*Validator) NonZero

func (v *Validator) NonZero(src int, name string)

NonZero verifies that a map is not empty

func (*Validator) NotNil

func (v *Validator) NotNil(src interface{})

NotNil verifies that an attribute is not nil

func (*Validator) RFC1123Z

func (v *Validator) RFC1123Z(src string)

RFC1123Z verifies that src complies with RFC 1123-Z

func (*Validator) Report

func (v *Validator) Report() string

Report returns a description of all issues

func (*Validator) StringEquals

func (v *Validator) StringEquals(src, expected string)

StringEquals verifies a string

func (*Validator) StringNotEmpty

func (v *Validator) StringNotEmpty(src, name string)

StringNotEmpty verifies a string is not empty

func (*Validator) Timestamp

func (v *Validator) Timestamp(src string)

Timestamp validates that src is a valid UNIX timestamp

func (*Validator) Validate

func (v *Validator) Validate(src Validatable) *Validator

Validate starts the chain of validations