Documentation
¶
Index ¶
- Variables
- type DefaultRawParser
- type EndParser
- type FieldParsedValidations
- type RawParser
- type StructParsedValidations
- func (s *StructParsedValidations) AddField(fieldName string, fieldParsedValidations *FieldParsedValidations)
- func (s *StructParsedValidations) AddNestedStruct(fieldName string, nestedStructParsedValidations *StructParsedValidations)
- func (s *StructParsedValidations) GetField(fieldName string) *FieldParsedValidations
- func (s *StructParsedValidations) GetFields() map[string]*FieldParsedValidations
- func (s *StructParsedValidations) GetNestedStruct(nestedStruct string) *StructParsedValidations
- func (s *StructParsedValidations) GetNestedStructs() map[string]*StructParsedValidations
- func (s *StructParsedValidations) GetStructTypeName() string
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type DefaultRawParser ¶
type DefaultRawParser struct {
// contains filtered or unexported fields
}
DefaultRawParser is a struct that holds the default raw parser
func NewDefaultRawParser ¶
func NewDefaultRawParser( logger *slog.Logger, ) *DefaultRawParser
NewDefaultRawParser creates a new DefaultRawParser struct
Parameters:
- logger: The logger to use
Returns:
- *DefaultRawParser: The new DefaultRawParser struct
func (DefaultRawParser) ParseValidations ¶
func (d DefaultRawParser) ParseValidations( structValidations *govalidatormappervalidation.StructValidations, dest *StructParsedValidations, ) error
ParseValidations returns the parsed validations from the struct validations
Parameters:
- structValidations: The root struct validations
- dest: The root struct parsed validations to populate
Returns:
- error: An error if the root struct validations or the root struct parsed validations are nil
type EndParser ¶
type EndParser interface {
ParseValidations(structParsedValidations *StructParsedValidations) (
any,
error,
)
}
EndParser is an interface to parse the root struct validations into a final format
type FieldParsedValidations ¶
type FieldParsedValidations struct {
// contains filtered or unexported fields
}
FieldParsedValidations is the struct for the field 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(err string)
AddError adds an error to the field parsed validations
Parameters:
- err: 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 RawParser ¶
type RawParser interface {
ParseValidations(
structValidations *govalidatormappervalidation.StructValidations,
dest *StructParsedValidations,
) error
}
RawParser is an interface to generate parsed validations from struct fields validations
type StructParsedValidations ¶
type StructParsedValidations struct {
// contains filtered or unexported fields
}
StructParsedValidations is the struct for the struct 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) AddField ¶
func (s *StructParsedValidations) AddField( fieldName string, fieldParsedValidations *FieldParsedValidations, )
AddField 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) AddNestedStruct ¶
func (s *StructParsedValidations) AddNestedStruct( fieldName string, nestedStructParsedValidations *StructParsedValidations, )
AddNestedStruct 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) GetField ¶
func (s *StructParsedValidations) GetField(fieldName string) *FieldParsedValidations
GetField 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) GetFields ¶
func (s *StructParsedValidations) GetFields() map[string]*FieldParsedValidations
GetFields returns the fields parsed validations from the struct parsed validations
Returns:
- map[string]*FieldParsedValidations: The fields parsed validations
func (*StructParsedValidations) GetNestedStruct ¶
func (s *StructParsedValidations) GetNestedStruct(nestedStruct string) *StructParsedValidations
GetNestedStruct 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) GetNestedStructs ¶
func (s *StructParsedValidations) GetNestedStructs() map[string]*StructParsedValidations
GetNestedStructs returns the nested structs parsed validations from the struct parsed validations
Returns:
- map[string]*StructParsedValidations: The nested structs 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
Directories