validates

Documentation

Index

• func Feature(config ...func(*Installer)) miruken.Feature
• func Groups(groups ...any) miruken.Constraint
• func Output(installer *Installer)
• type Builder
  • func (b *Builder) ForSource(source any) *Builder
  • func (b *Builder) New() *It
• type Constraints
  • func (p *Constraints) AppliesTo(callback miruken.Callback) bool
  • func (p *Constraints) Filters(binding miruken.Binding, callback any, composer miruken.Handler) ([]miruken.Filter, error)
  • func (p *Constraints) InitWithTag(tag reflect.StructTag) error
  • func (p *Constraints) Required() bool
  • func (p *Constraints) ValidateOutput() bool
• type Group
  • func (g *Group) Implied() bool
  • func (g *Group) InitWithTag(tag reflect.StructTag) error
  • func (g *Group) Merge(constraint miruken.Constraint) bool
  • func (g *Group) Required() bool
  • func (g *Group) Satisfies(required miruken.Constraint, _ miruken.Callback) bool
• type Installer
  • func (v *Installer) Install(setup *miruken.SetupBuilder) error
  • func (v *Installer) Output()
• type It
  • func (v *It) Dispatch(handler any, greedy bool, composer miruken.Handler) miruken.HandleResult
  • func (v *It) Groups() []any
  • func (v *It) InGroup(group any) bool
  • func (v *It) Key() any
  • func (v *It) Outcome() *Outcome
  • func (v *It) Policy() miruken.Policy
  • func (v *It) Source() any
  • func (v *It) String() string
• type Outcome
  • func Input(handler miruken.Handler, source any, constraints ...any) (o *Outcome, po *promise.Promise[*Outcome], err error)
  • func (o *Outcome) AddError(path string, err error)
  • func (o *Outcome) Error() string
  • func (o *Outcome) FieldErrors(path string) []error
  • func (o *Outcome) Fields() []string
  • func (o *Outcome) Path(path string) *Outcome
  • func (o *Outcome) RequirePath(path string) *Outcome
  • func (o *Outcome) Valid() bool
• type Strict

Functions

func Feature

func Feature(config ...func(*Installer)) miruken.Feature

Feature creates and configures validation support.

func Groups

func Groups(groups ...any) miruken.Constraint

Groups builds a validation Group constraint.

func Output

func Output(installer *Installer)

Types

type Builder

type Builder struct {
	miruken.CallbackBuilder
	// contains filtered or unexported fields
}

Builder builds It callbacks.

func (*Builder) ForSource

func (b *Builder) ForSource(
	source any,
) *Builder

func (*Builder) New

func (b *Builder) New() *It

type Constraints

type Constraints struct {
	// contains filtered or unexported fields
}

Constraints is a FilterProvider for validation.

func (*Constraints) AppliesTo

func (p *Constraints) AppliesTo(
	callback miruken.Callback,
) bool

func (*Constraints) Filters

func (p *Constraints) Filters(
	binding miruken.Binding,
	callback any,
	composer miruken.Handler,
) ([]miruken.Filter, error)

func (*Constraints) InitWithTag

func (p *Constraints) InitWithTag(tag reflect.StructTag) error

func (*Constraints) Required

func (p *Constraints) Required() bool

func (*Constraints) ValidateOutput

func (p *Constraints) ValidateOutput() bool

type Group

type Group struct {
	// contains filtered or unexported fields
}

Group marks a set of related validations.

func (*Group) Implied

func (g *Group) Implied() bool

func (*Group) InitWithTag

func (g *Group) InitWithTag(tag reflect.StructTag) error

func (*Group) Merge

func (g *Group) Merge(constraint miruken.Constraint) bool

func (*Group) Required

func (g *Group) Required() bool

func (*Group) Satisfies

func (g *Group) Satisfies(required miruken.Constraint, _ miruken.Callback) bool

type Installer

type Installer struct {
	// contains filtered or unexported fields
}

Installer enables validation support.

func (*Installer) Install

func (v *Installer) Install(setup *miruken.SetupBuilder) error

func (*Installer) Output

func (v *Installer) Output()

type It

type It struct {
	miruken.CallbackBase
	// contains filtered or unexported fields
}

It validates callbacks contravariantly.

func (*It) Dispatch

func (v *It) Dispatch(
	handler any,
	greedy bool,
	composer miruken.Handler,
) miruken.HandleResult

func (*It) Groups

func (v *It) Groups() []any

func (*It) InGroup

func (v *It) InGroup(group any) bool

func (*It) Key

func (v *It) Key() any

func (*It) Outcome

func (v *It) Outcome() *Outcome

func (*It) Policy

func (v *It) Policy() miruken.Policy

func (*It) Source

func (v *It) Source() any

func (*It) String

func (v *It) String() string

type Outcome

type Outcome struct {
	// contains filtered or unexported fields
}

Outcome captures structured validation errors.

func Input

func Input(
	handler miruken.Handler,
	source any,
	constraints ...any,
) (o *Outcome, po *promise.Promise[*Outcome], err error)

Input performs all validations on `source`.

func (*Outcome) AddError

func (o *Outcome) AddError(
	path string,
	err error,
)

func (*Outcome) Error

func (o *Outcome) Error() string

func (*Outcome) FieldErrors

func (o *Outcome) FieldErrors(
	path string,
) []error

func (*Outcome) Fields

func (o *Outcome) Fields() []string

func (*Outcome) Path

func (o *Outcome) Path(
	path string,
) *Outcome

func (*Outcome) RequirePath

func (o *Outcome) RequirePath(
	path string,
) *Outcome

func (*Outcome) Valid

func (o *Outcome) Valid() bool

type Strict

type Strict = miruken.Strict

Strict alias for validation