Documentation
¶
Index ¶
- Constants
- Variables
- type FieldParsedValidations
- type FlattenedParsedValidations
- func (f *FlattenedParsedValidations) AddFieldParsedValidations(fieldName string, fieldParsedValidations *FieldParsedValidations) error
- func (f *FlattenedParsedValidations) AddNestedStructParsedValidations(fieldName string, structParsedValidations *StructParsedValidations) error
- func (f *FlattenedParsedValidations) AddRootStructParsedValidations(structParsedValidations *StructParsedValidations) error
- func (f *FlattenedParsedValidations) GetFields() *map[string]interface{}
- type Parser
- type StructParsedValidations
- func (s *StructParsedValidations) AddFieldParsedValidations(fieldName string, fieldParsedValidations *FieldParsedValidations)
- func (s *StructParsedValidations) AddNestedStructParsedValidations(fieldName string, nestedStructParsedValidations *StructParsedValidations)
- func (s *StructParsedValidations) GetFieldParsedValidations(fieldName string) *FieldParsedValidations
- func (s *StructParsedValidations) GetFieldsParsedValidations() *map[string]*FieldParsedValidations
- func (s *StructParsedValidations) GetNestedStructParsedValidations(nestedStruct string) *StructParsedValidations
- func (s *StructParsedValidations) GetStructTypeName() string
Constants ¶
const (
ErrNilFieldNameAlreadyParsed = "field name already parsed: %s"
)
Variables ¶
Functions ¶
This section is empty.
Types ¶
type FieldParsedValidations ¶
type FieldParsedValidations struct {
// contains filtered or unexported fields
}
FieldParsedValidations is the struct for the field JSON parsed validations
func NewFieldParsedValidations ¶
func NewFieldParsedValidations() *FieldParsedValidations
NewFieldParsedValidations creates a new FieldParsedValidations struct
Returns:
- *FieldParsedValidations: The new FieldParsedValidations struct
func (*FieldParsedValidations) AddError ¶
func (f *FieldParsedValidations) AddError(error string)
AddError adds an error to the field parsed validations
Parameters:
- error: The error to add
func (*FieldParsedValidations) AddErrors ¶
func (f *FieldParsedValidations) AddErrors(errors *[]error)
AddErrors adds errors to the field parsed validations
Parameters:
- errors: The errors to add
func (*FieldParsedValidations) GetErrors ¶
func (f *FieldParsedValidations) GetErrors() *[]string
GetErrors returns the errors from the field parsed validations
Returns:
- *[]string: The errors
type FlattenedParsedValidations ¶
type FlattenedParsedValidations struct {
// contains filtered or unexported fields
}
FlattenedParsedValidations is the struct for the flattened JSON parsed validations
func NewFlattenedParsedValidations ¶
func NewFlattenedParsedValidations() *FlattenedParsedValidations
NewFlattenedParsedValidations creates a new FlattenedParsedValidations struct
Returns:
- *FlattenedParsedValidations: The new FlattenedParsedValidations struct
func (*FlattenedParsedValidations) AddFieldParsedValidations ¶
func (f *FlattenedParsedValidations) AddFieldParsedValidations( fieldName string, fieldParsedValidations *FieldParsedValidations, ) error
AddFieldParsedValidations adds a field parsed validations to the flattened JSON parsed validations
Parameters:
- fieldName: The name of the field
- fieldParsedValidations: The field parsed validations to add
Returns:
- error: An error if the field name is already in the flattened JSON parsed validations
func (*FlattenedParsedValidations) AddNestedStructParsedValidations ¶
func (f *FlattenedParsedValidations) AddNestedStructParsedValidations( fieldName string, structParsedValidations *StructParsedValidations, ) error
AddNestedStructParsedValidations adds a nested struct parsed validations to the flattened JSON parsed validations
Parameters:
- fieldName: The name of the field that holds the nested struct
- structParsedValidations: The struct parsed validations to add
Returns:
- error: An error if the struct name is already in the flattened JSON parsed validations
func (*FlattenedParsedValidations) AddRootStructParsedValidations ¶
func (f *FlattenedParsedValidations) AddRootStructParsedValidations( structParsedValidations *StructParsedValidations, ) error
AddRootStructParsedValidations adds the root struct parsed validations to the flattened JSON parsed validations
Parameters:
- structParsedValidations: The root struct parsed validations to add
Returns:
- error: An error if the root struct parsed validations are nil or if the fields are already in the flattened JSON parsed validations
func (*FlattenedParsedValidations) GetFields ¶
func (f *FlattenedParsedValidations) GetFields() *map[string]interface{}
GetFields returns the fields from the flattened JSON parsed validations
Returns:
- *map[string]interface{}: The fields
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser is a struct that holds the JSON parser
func NewParser ¶
NewParser creates a new Parser struct
Parameters:
- logger: The logger to use
Returns:
- *Parser: The new Parser struct
func (Parser) GenerateParsedValidations ¶
func (p Parser) GenerateParsedValidations( rootStructValidations *govalidatormappervalidation.StructValidations, rootStructParsedValidations *StructParsedValidations, ) error
GenerateParsedValidations returns the JSON parsed validations from the struct validations
Parameters:
- rootStructValidations: The root struct validations
- rootStructParsedValidations: The root struct parsed validations to populate
Returns:
- error: An error if the root struct validations or the root struct parsed validations are nil
func (Parser) ParseValidations ¶
func (p Parser) ParseValidations(rootStructValidations *govalidatormappervalidation.StructValidations) ( interface{}, error, )
ParseValidations parses the validations into JSON
Parameters:
- rootStructValidations: The root struct validations
Returns:
- interface{}: The parsed validations
- error: An error if the root struct validations are nil or if there was an error generating or flattening the parsed validations
type StructParsedValidations ¶
type StructParsedValidations struct {
// contains filtered or unexported fields
}
StructParsedValidations is the struct for the struct JSON parsed validations
func NewNestedStructParsedValidations ¶
func NewNestedStructParsedValidations( fieldName string, structTypeName string, ) *StructParsedValidations
NewNestedStructParsedValidations creates a new nested StructParsedValidations struct
Parameters:
- fieldName: The name of the field that holds the nested struct
- structTypeName: The name of the nested struct type
Returns:
- *StructParsedValidations: The new nested StructParsedValidations struct
func NewStructParsedValidations ¶
func NewStructParsedValidations(structTypeName string) *StructParsedValidations
NewStructParsedValidations creates a new StructParsedValidations struct
Parameters:
- structTypeName: The name of the struct type
Returns:
- *StructParsedValidations: The new StructParsedValidations struct
func (*StructParsedValidations) AddFieldParsedValidations ¶
func (s *StructParsedValidations) AddFieldParsedValidations( fieldName string, fieldParsedValidations *FieldParsedValidations, )
AddFieldParsedValidations adds a field parsed validations to the struct parsed validations
Parameters:
- fieldName: The name of the field
- fieldParsedValidations: The field parsed validations to add
func (*StructParsedValidations) AddNestedStructParsedValidations ¶
func (s *StructParsedValidations) AddNestedStructParsedValidations( fieldName string, nestedStructParsedValidations *StructParsedValidations, )
AddNestedStructParsedValidations adds a nested struct parsed validations to the struct parsed validations
Parameters:
- fieldName: The name of the field that holds the nested struct
- nestedStructParsedValidations: The nested struct parsed validations to add
func (*StructParsedValidations) GetFieldParsedValidations ¶
func (s *StructParsedValidations) GetFieldParsedValidations(fieldName string) *FieldParsedValidations
GetFieldParsedValidations returns the field parsed validations from the struct parsed validations
Parameters:
- fieldName: The name of the field
Returns:
- *FieldParsedValidations: The field parsed validations
func (*StructParsedValidations) GetFieldsParsedValidations ¶
func (s *StructParsedValidations) GetFieldsParsedValidations() *map[string]*FieldParsedValidations
GetFieldsParsedValidations returns the fields parsed validations from the struct parsed validations
Returns:
- *map[string]*FieldParsedValidations: The fields parsed validations
func (*StructParsedValidations) GetNestedStructParsedValidations ¶
func (s *StructParsedValidations) GetNestedStructParsedValidations(nestedStruct string) *StructParsedValidations
GetNestedStructParsedValidations returns the nested struct parsed validations from the struct parsed validations
Parameters:
- nestedStruct: The name of the nested struct
Returns:
- *StructParsedValidations: The nested struct parsed validations
func (*StructParsedValidations) GetStructTypeName ¶
func (s *StructParsedValidations) GetStructTypeName() string
GetStructTypeName returns the struct type name from the struct parsed validations
Returns:
- string: The struct type name
Source Files