README
¶
Validation Package
This Go package provides a flexible framework for validating struct fields using custom rules. It leverages Go's reflection to apply both user-defined and built-in validation rules to struct fields, making it easy to enforce constraints on your data.
Features
- Customizable Rules: Easily define your own validation functions using the
Ruletype. - Schema-Based Validation: Associate one or more rules with struct fields via a
Schemamap. - Built-in Validators: Includes a variety of common validators:
- Required field checks
- String length checks (
MaxLen,MinLen,ExactLen) - Numeric bounds (
MaxValue,MinValue,GreaterThan,LessThan,Between) - Regular expression matches, including email, URL, UUID, and more
- IP address (IPv4/IPv6) validation
- Date, time, and datetime format validation
Code Structure
-
rule.go:
Defines theRuletype and provides helper functions to compose multiple rules. -
schema.go:
Implements theSchematype and itsValidatemethod, which iterates over struct fields and applies associated validation rules. -
default_rules.go:
Contains built-in validation functions for common requirements. These include checks for required values, length constraints, numeric comparisons, regex matching, and specialized validations (like email, URL, IP addresses, dates, etc.).
Installation
Simply add the source files to your project and import the package in your Go code:
import "path/to/validation"
Ensure that the package path reflects the actual location of the code in your project.
Usage Example
Define a struct and a corresponding schema that maps field names to a list of rules:
package main
import (
"fmt"
"validation"
)
type User struct {
Name string
Email string
Age int
}
func main() {
// Define validation schema for the User struct
schema := validation.Schema{
"Name": validation.Rules(validation.Required(), validation.MinLen(2)),
"Email": validation.Rules(validation.Required(), validation.Email()),
"Age": validation.Rules(validation.Required(), validation.MinValue(18)),
}
user := User{Name: "John Doe", Email: "john@example.com", Age: 25}
if err := schema.Validate(user); err != nil {
fmt.Println("Validation error:", err)
} else {
fmt.Println("Validation successful!")
}
}
This example demonstrates how to validate a User struct by ensuring that:
- The
Namefield is provided and is at least 2 characters long. - The
Emailfield is provided and follows a valid email format. - The
Agefield is provided and is at least 18.
Contributing
Contributions to enhance or expand the validation functionality are welcome. Feel free to fork the repository and submit a pull request with your improvements.
License
This package is distributed under the MIT License. See the LICENSE file for more details.
Documentation
¶
Index ¶
- Variables
- type Rule
- func Alpha() Rule
- func Alphanumeric() Rule
- func Between(min, max float64) Rule
- func ContainsDigit() Rule
- func ContainsLower() Rule
- func ContainsSpecial() Rule
- func ContainsUpper() Rule
- func Date() Rule
- func DateTime() Rule
- func Email() Rule
- func EndsWith(suffix string) Rule
- func ExactLen(n int) Rule
- func GreaterThan(n float64) Rule
- func IP() Rule
- func IPv4() Rule
- func IPv6() Rule
- func LessThan(n float64) Rule
- func MaxLen(n int) Rule
- func MaxValue(n float64) Rule
- func MinLen(n int) Rule
- func MinValue(n float64) Rule
- func Numeric() Rule
- func RegexMatch(pattern string) Rule
- func Required() Rule
- func Rules(rules ...Rule) []Rule
- func StartsWith(prefix string) Rule
- func Time() Rule
- func URL() Rule
- func UUID() Rule
- type Schema
Constants ¶
This section is empty.
Variables ¶
var Types = map[reflect.Kind]string{ reflect.Invalid: "invalid", reflect.Bool: "bool", reflect.Int: "int", reflect.Int8: "int8", reflect.Int16: "int16", reflect.Int32: "int32", reflect.Int64: "int64", reflect.Uint: "uint", reflect.Uint8: "uint8", reflect.Uint16: "uint16", reflect.Uint32: "uint32", reflect.Uint64: "uint64", reflect.Uintptr: "uintptr", reflect.Float32: "float32", reflect.Float64: "float64", reflect.Complex64: "complex64", reflect.Complex128: "complex128", reflect.Array: "array", reflect.Chan: "chan", reflect.Func: "func", reflect.Interface: "interface", reflect.Map: "map", reflect.Pointer: "pointer", reflect.Slice: "slice", reflect.String: "string", reflect.Struct: "struct", reflect.UnsafePointer: "unsafe_pointer", }
Functions ¶
This section is empty.
Types ¶
type Rule ¶
func Alphanumeric ¶
func Alphanumeric() Rule
func ContainsDigit ¶
func ContainsDigit() Rule
func ContainsLower ¶
func ContainsLower() Rule
func ContainsSpecial ¶
func ContainsSpecial() Rule
func ContainsUpper ¶
func ContainsUpper() Rule
Source Files