fend

Documentation

Index

• func Union[T any](rules ...Rules[T]) rule.Rule[T]
• type Error
  • func AsError(err error) *Error
  • func NewError(path string, ruleErrs ...*rule.Error) *Error
  • func NewRuleError(path string, ruleName rule.Name, meta ...string) *Error
  • func (e *Error) Error() string
  • func (e *Error) Errors() []error
  • func (e *Error) Name() string
• type Fend
  • func DynamicField(path string, rules ...rule.DynamicRule) Fend
  • func DynamicVar(rules ...rule.DynamicRule) Fend
  • func Field[T any](path string, value T, rules ...rule.Rule[T]) Fend
  • func Var[T any](value T, rules ...rule.Rule[T]) Fend
• type Fends
  • func (f Fends) Append(v ...Fend) Fends
  • func (f Fends) Prepend(v ...Fend) Fends
• type Mode
• type Rules
  • func NewRules[T any](rules ...rule.Rule[T]) Rules[T]
  • func (r Rules[T]) DynamicField(path string, rules ...rule.DynamicRule) Fend
  • func (r Rules[T]) DynamicVar(rules ...rule.DynamicRule) Fend
  • func (r Rules[T]) Field(path string, value T, rules ...rule.Rule[T]) Fend
  • func (r Rules[T]) Var(value T, rules ...rule.Rule[T]) Fend

Examples

• Union

Functions

func Union

func Union[T any](rules ...Rules[T]) rule.Rule[T]

Example

package main

import (
	"context"
	"fmt"

	"github.com/foomo/fender"
	"github.com/foomo/fender/fend"
	"github.com/foomo/fender/rule"
)

func main() {
	email := fend.NewRules(rule.StringMin(5), rule.Email)
	phone := fend.NewRules(rule.StringMin(3), rule.Numeric)
	emailOrPhone := fend.NewRules(fend.Union(email, phone))

	{
		err := fender.All(context.TODO(),
			fend.Var("foo", fend.Union(email, phone)),
		)
		fmt.Println(err)
	}
	{
		err := fender.All(context.TODO(),
			emailOrPhone.Var("foo"),
		)
		fmt.Println(err)
	}

	{
		err := fender.All(context.TODO(),
			fend.Var("foo@bar.com", fend.Union(email, phone)),
		)
		fmt.Println(err)
	}
	{
		err := fender.All(context.TODO(),
			emailOrPhone.Var("foo@bar.com"),
		)
		fmt.Println(err)
	}

	{
		err := fender.All(context.TODO(),
			fend.Var("123456", fend.Union(email, phone)),
		)
		fmt.Println(err)
	}
	{
		err := fender.All(context.TODO(),
			emailOrPhone.Var("123456"),
		)
		fmt.Println(err)
	}

}

Output:

numeric=^[0-9]+$
numeric=^[0-9]+$
<nil>
<nil>
<nil>
<nil>

Types

type Error

type Error struct {
	Path     string
	RuleErrs []*rule.Error
}

func AsError

func AsError(err error) *Error

func NewError

func NewError(path string, ruleErrs ...*rule.Error) *Error

func NewRuleError

func NewRuleError(path string, ruleName rule.Name, meta ...string) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Errors

func (e *Error) Errors() []error

func (*Error) Name

func (e *Error) Name() string

type Fend

type Fend func(ctx context.Context, mode Mode) error

func DynamicField

func DynamicField(path string, rules ...rule.DynamicRule) Fend

func DynamicVar

func DynamicVar(rules ...rule.DynamicRule) Fend

func Field

func Field[T any](path string, value T, rules ...rule.Rule[T]) Fend

func Var

func Var[T any](value T, rules ...rule.Rule[T]) Fend

type Fends

type Fends []Fend

func (Fends) Append

func (f Fends) Append(v ...Fend) Fends

func (Fends) Prepend

func (f Fends) Prepend(v ...Fend) Fends

type Mode

type Mode int

const (
	ModeAll Mode = iota
	ModeFirst
	ModeAllFirst
)

type Rules

type Rules[T any] []rule.Rule[T]

func NewRules

func NewRules[T any](rules ...rule.Rule[T]) Rules[T]

func (Rules[T]) DynamicField

func (r Rules[T]) DynamicField(path string, rules ...rule.DynamicRule) Fend

func (Rules[T]) DynamicVar

func (r Rules[T]) DynamicVar(rules ...rule.DynamicRule) Fend

func (Rules[T]) Field

func (r Rules[T]) Field(path string, value T, rules ...rule.Rule[T]) Fend

func (Rules[T]) Var

func (r Rules[T]) Var(value T, rules ...rule.Rule[T]) Fend