validations

Documentation

Index

• Variables
• type FieldValidations
  • func NewFieldValidations() *FieldValidations
  • func (f *FieldValidations) AddValidationError(validationError error)
  • func (f *FieldValidations) GetErrors() *[]error
  • func (f *FieldValidations) HasFailed() bool
• type StructValidations
  • func NewNestedStructValidations(fieldName string, instance interface{}) (*StructValidations, error)
  • func NewStructValidations(instance interface{}) (*StructValidations, error)
  • func (s *StructValidations) AddFieldValidationError(fieldName string, validationError error)
  • func (s *StructValidations) AddFieldValidations(fieldName string, fieldValidations *FieldValidations)
  • func (s *StructValidations) AddNestedStructValidations(fieldName string, nestedStructValidations *StructValidations)
  • func (s *StructValidations) GetFieldsValidations() *map[string]*FieldValidations
  • func (s *StructValidations) GetNestedStructsValidations() *map[string]*StructValidations
  • func (s *StructValidations) GetReflection() *goreflect.Reflection
  • func (s *StructValidations) GetStructTypeName() string
  • func (s *StructValidations) HasFailed() bool

Variables

var (
	ErrNilInstance          = errors.New("struct instance cannot be nil")
	ErrNilStructValidations = errors.New("struct validations is nil")
	ErrNilFieldValidations  = errors.New("field validations is nil")
)

Types

type FieldValidations

type FieldValidations struct {
	// contains filtered or unexported fields
}

FieldValidations is a struct that holds the field validations for the generated validations of a struct

func NewFieldValidations

func NewFieldValidations() *FieldValidations

NewFieldValidations creates a new FieldValidations struct

func (*FieldValidations) AddValidationError

func (f *FieldValidations) AddValidationError(
	validationError error,
)

AddValidationError adds a validation error to the field

func (*FieldValidations) GetErrors

func (f *FieldValidations) GetErrors() *[]error

GetErrors returns the field errors

func (*FieldValidations) HasFailed

func (f *FieldValidations) HasFailed() bool

HasFailed returns true if there are failed validations

type StructValidations

type StructValidations struct {
	// contains filtered or unexported fields
}

StructValidations is a struct that holds the struct validations for the generated validations of a struct

func NewNestedStructValidations

func NewNestedStructValidations(
	fieldName string,
	instance interface{},
) (*StructValidations, error)

NewNestedStructValidations creates a new nested StructValidations struct

func NewStructValidations

func NewStructValidations(instance interface{}) (*StructValidations, error)

NewStructValidations creates a new StructValidations struct

func (*StructValidations) AddFieldValidationError

func (s *StructValidations) AddFieldValidationError(
	fieldName string,
	validationError error,
)

AddFieldValidationError adds a validation error to the field

func (*StructValidations) AddFieldValidations

func (s *StructValidations) AddFieldValidations(
	fieldName string,
	fieldValidations *FieldValidations,
)

AddFieldValidations sets the fields validations to the struct

func (*StructValidations) AddNestedStructValidations

func (s *StructValidations) AddNestedStructValidations(
	fieldName string,
	nestedStructValidations *StructValidations,
)

AddNestedStructValidations sets the nested struct fields validations to the struct

func (*StructValidations) GetFieldsValidations

func (s *StructValidations) GetFieldsValidations() *map[string]*FieldValidations

GetFieldsValidations returns the fields validations

func (*StructValidations) GetNestedStructsValidations

func (s *StructValidations) GetNestedStructsValidations() *map[string]*StructValidations

GetNestedStructsValidations returns the nested structs validations

func (*StructValidations) GetReflection

func (s *StructValidations) GetReflection() *goreflect.Reflection

GetReflection returns the reflection of the struct

func (*StructValidations) GetStructTypeName

func (s *StructValidations) GetStructTypeName() string

GetStructTypeName returns the type name of the struct

func (*StructValidations) HasFailed

func (s *StructValidations) HasFailed() bool

HasFailed returns true if there are failed validations