owl

README

a zero dependency performant validation library

Rules

Name	Description	Status
required	not nil or zero value	✅
default	default value	✅
enum	one of a set of options	⌛

String

Name	Description	Status
pattern	match regular expression	✅
format	match format	✅
min	min length	✅
max	max length	✅

Numeric

Name	Description	Status
min	minimum	✅
max	maximum	✅

Formats

Name	Status
date_time	✅
email	✅
ipv4	✅
ipv6	✅
uri	✅
uuid	✅

Documentation

Index

• func AddFormat(name string, formatter Formatter)
• func AddRule(name string, rule Rule)
• func New() *owl
• type Error
  • func Validate(v any) []Error
  • func (self Error) Error() string
• type Formatter
• type Rule

Functions

func AddFormat

func AddFormat(name string, formatter Formatter)

func AddRule

func AddRule(name string, rule Rule)

func New

func New() *owl

Types

type Error

type Error struct {
	Path    string `json:"path"`
	Keyword string `json:"keyword"`
	Message string `json:"message"`
}

func Validate

func Validate(v any) []Error

func (Error) Error

func (self Error) Error() string

type Formatter

type Formatter func(string) error

type Rule

type Rule interface {
	Select(
		schema map[string]string,
		parent reflect.Value,
		value reflect.Value,
	) bool

	Validate(
		schema map[string]string,
		parent reflect.Value,

		value reflect.Value,
	) (reflect.Value, []error)
}