validation

package

v0.5.7 Latest Latest Go to latest Published: Apr 4, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bir/iken

Links

Open Source Insights

Documentation ¶

Index ¶

func Join(elems []error, sep string) string
func New(field string, msg any) error
type Error
type Errors
type Messages
- func (mm Messages) Error() string
- func (mm Messages) Unwrap() []error
type UserError

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Join ¶ added in v0.4.0

func Join(elems []error, sep string) string

func New ¶

func New(field string, msg any) error

New returns a single validation error for the field with msg.

Types ¶

type Error ¶ added in v0.4.4

type Error struct {
	Message string
	Source  error
}

func (Error) Error ¶ added in v0.4.4

func (e Error) Error() string

func (Error) Unwrap ¶ added in v0.4.16

func (e Error) Unwrap() error

func (Error) UserError ¶ added in v0.4.4

func (e Error) UserError() string

type Errors ¶

type Errors map[string]Messages //nolint: errname

Errors maps fields to the list of validation failures.

func (*Errors) Add ¶

func (ee *Errors) Add(field string, msg any) *Errors

Add appends the field and msg to the current list of errors. Add will initialize the Errors object if it is not initialized. If msg is `error` it is added directly, otherwise the value is converted to a string and added.

func (*Errors) Error ¶

func (ee *Errors) Error() string

Error returns the error string of Errors.

func (*Errors) Fields ¶ added in v0.4.4

func (ee *Errors) Fields() map[string][]string

func (*Errors) GetErr ¶

func (ee *Errors) GetErr() error

GetErr allows you to use a nil Errors object and return directly. If there are no validation errors it returns nil.

func (*Errors) Keys ¶ added in v0.0.9

func (ee *Errors) Keys() []string

func (*Errors) Unwrap ¶ added in v0.4.16

func (ee *Errors) Unwrap() []error

type Messages ¶

type Messages []error //nolint: errname

Messages are the validation failures for a given field.

func (Messages) Error ¶

func (mm Messages) Error() string

func (Messages) Unwrap ¶ added in v0.4.16

func (mm Messages) Unwrap() []error

type UserError ¶ added in v0.4.4

type UserError interface {
	error
	UserError() string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL