iris/x/errors/validation/number.go

106 lines
2.5 KiB
Go

package validation
import (
"fmt"
"golang.org/x/exp/constraints"
)
// NumberValue is a type constraint that accepts any numeric type.
type NumberValue interface {
constraints.Integer | constraints.Float
}
// NumberError describes a number field validation error.
type NumberError[T NumberValue] struct{ *FieldError[T] }
// Number returns a new number validation error.
func Number[T NumberValue](field string, value T) *NumberError[T] {
return &NumberError[T]{Field(field, value)}
}
// Positive adds an error if the value is not positive.
func (e *NumberError[T]) Positive() *NumberError[T] {
e.Func(Positive)
return e
}
// Negative adds an error if the value is not negative.
func (e *NumberError[T]) Negative() *NumberError[T] {
e.Func(Negative)
return e
}
// Zero reports whether the value is zero.
func (e *NumberError[T]) Zero() *NumberError[T] {
e.Func(Zero)
return e
}
// NonZero adds an error if the value is zero.
func (e *NumberError[T]) NonZero() *NumberError[T] {
e.Func(NonZero)
return e
}
// InRange adds an error if the value is not in the range.
func (e *NumberError[T]) InRange(min, max T) *NumberError[T] {
e.Func(InRange(min, max))
return e
}
// Positive accepts any numeric type and
// returns a message if the value is not positive.
func Positive[T NumberValue](n T) string {
if n <= 0 {
return "must be positive"
}
return ""
}
// Negative accepts any numeric type and returns a message if the value is not negative.
func Negative[T NumberValue](n T) string {
if n >= 0 {
return "must be negative"
}
return ""
}
// Zero accepts any numeric type and returns a message if the value is not zero.
func Zero[T NumberValue](n T) string {
if n != 0 {
return "must be zero"
}
return ""
}
// NonZero accepts any numeric type and returns a message if the value is not zero.
func NonZero[T NumberValue](n T) string {
if n == 0 {
return "must not be zero"
}
return ""
}
// InRange accepts any numeric type and returns a message if the value is not in the range.
func InRange[T NumberValue](min, max T) func(T) string {
return func(n T) string {
if n < min || n > max {
return "must be in range of " + FormatRange(min, max)
}
return ""
}
}
// FormatRange returns a string representation of a range of values, such as "[1, 10]".
// It uses a type constraint NumberValue, which means that the parameters must be numeric types
// that support comparison and formatting operations.
func FormatRange[T NumberValue](min, max T) string {
return fmt.Sprintf("[%v, %v]", min, max)
}