fender

README

fender

a piece of rope or a tyre that protects the side of a boat from knocks

Fender provides a unified way to validate data and on the backend & frontend side.

Usage

All

func ExampleAll() {
	err := fender.All(
		context.Background(),
		fend.Field("one", "", rule.RequiredString, rule.MinString(10)),
		fend.Field("two", "", rule.RequiredString, rule.MinString(10)),
	)
	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
	// Output: one:required:min=10;two:required:min=10
}

AllFirst

func ExampleAllFirst() {
	err := fender.AllFirst(
		context.Background(),
		fend.Field("one", "", rule.RequiredString, rule.MinString(10)),
		fend.Field("two", "", rule.RequiredString, rule.MinString(10)),
	)

	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
	// Output: one:required:min=10
}

First

func ExampleFirst() {
	err := fender.First(
		context.Background(),
		fend.Field("one", "", rule.RequiredString, rule.MinString(10)),
		fend.Field("two", "", rule.RequiredString, rule.MinString(10)),
	)

	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
	// Output: one:required
}

Handle errors

func ExampleErrors() {
	err := fender.All(
		context.Background(),
		fend.Field("one", "", rule.RequiredString, rule.MinString(10)),
		fend.Field("two", "", rule.RequiredString, rule.MinString(10)),
	)

	// cast fender error
	if fenderErr := fender.AsError(err); fenderErr != nil {

		// iterate fend errors
		for _, err := range fenderErr.Errors() {

			// cast fend error
			if fendErr := fend.AsError(err); fendErr != nil {

				fmt.Println(fendErr.Name())

				// iterate rule errors
				for _, err := range fendErr.Errors() {

					// cast rule error
					if ruleErr := rule.AsError(err); ruleErr != nil {
						fmt.Println(ruleErr.Error())
					}
				}
			}
		}
	} else if err != nil {
		panic(err)
	}
	// Output:
	// one
	// required
	// min=10
	// two
	// required
	// min=10
}

Benchmarks

go test -bench=. | prettybench
goos: darwin
goarch: arm64
pkg: github.com/foomo/fender
PASS
benchmark                                      iter       time/iter
---------                                      ----       ---------
BenchmarkAll/invalid_reused/fender-10        282154   3771.00 ns/op
BenchmarkAll/invalid_reused/playground-10    678679   1741.00 ns/op
BenchmarkAll/success_new/fender-10          1000000   1026.00 ns/op
BenchmarkAll/success_new/playground-10      1308327    937.60 ns/op
ok  	github.com/foomo/fender	5.619s

References & alternatives

• go-playground/validator
• go-ozzo/ozzo-validation

How to Contribute

Make a pull request...

License

Distributed under MIT License, please see license file within the code for more details.

Documentation

Index

• func All(ctx context.Context, fends ...fend.Fend) error
• func AllFirst(ctx context.Context, fends ...fend.Fend) error
• func First(ctx context.Context, fends ...fend.Fend) error
• func Mode(ctx context.Context, mode fend.Mode, fends ...fend.Fend) error
• type Error
  • func AsError(err error) *Error
  • func NewError(fendErrs ...*fend.Error) *Error
  • func NewFendError(name string, ruleErrs ...*rule.Error) *Error
  • func NewFendRuleError(name string, ruleName rule.Name, ruleMeta ...string) *Error
  • func (e *Error) Error() string
  • func (e *Error) Errors() []error
  • func (e *Error) First() error

Examples

• All
• AllFirst
• First

Functions

func All

func All(ctx context.Context, fends ...fend.Fend) error

Example

package main

import (
	"context"
	"fmt"

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

func main() {
	err := fender.All(
		context.Background(),
		fend.Field("one", "", rule.Required[string], rule.StringMin(10)),
		fend.Field("two", "", rule.Required[string], rule.StringMin(10)),
	)
	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
}

Output:

one:required:min=10;two:required:min=10

func AllFirst

func AllFirst(ctx context.Context, fends ...fend.Fend) error

Example

package main

import (
	"context"
	"fmt"

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

func main() {
	err := fender.AllFirst(
		context.Background(),
		fend.Field("one", "", rule.Required[string], rule.StringMin(10)),
		fend.Field("two", "", rule.Required[string], rule.StringMin(10)),
	)

	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
}

Output:

one:required:min=10

func First

func First(ctx context.Context, fends ...fend.Fend) error

Example

package main

import (
	"context"
	"fmt"

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

func main() {
	err := fender.First(
		context.Background(),
		fend.Field("one", "", rule.Required[string], rule.StringMin(10)),
		fend.Field("two", "", rule.Required[string], rule.StringMin(10)),
	)

	// check for fender error
	if fendErr := fender.AsError(err); fendErr != nil {
		fmt.Println(err)
	} else if err != nil {
		panic(err)
	}
}

Output:

one:required

func Mode

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

Types

type Error

type Error struct {
	FendErrs []*fend.Error
}

func AsError

func AsError(err error) *Error

func NewError

func NewError(fendErrs ...*fend.Error) *Error

func NewFendError

func NewFendError(name string, ruleErrs ...*rule.Error) *Error

func NewFendRuleError

func NewFendRuleError(name string, ruleName rule.Name, ruleMeta ...string) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Errors

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

func (*Error) First

func (e *Error) First() error