maps

Documentation

Index

• Constants
• Variables
• func All[T any](handler miruken.Handler, source any, constraints ...any) (t []T, _ *promise.Promise[[]T], _ error)
• type Builder
  • func (b *Builder) FromSource(source any) *Builder
  • func (b *Builder) New() *It
  • func (b *Builder) WithKey(key any) *Builder
• type Direction
• type Format
  • func From(format string, params map[string]string) *Format
  • func To(format string, params map[string]string) *Format
  • func (f *Format) Direction() Direction
  • func (f *Format) FlipDirection() *Format
  • func (f *Format) Implied() bool
  • func (f *Format) InitWithTag(tag reflect.StructTag) error
  • func (f *Format) Merge(constraint miruken.Constraint) bool
  • func (f *Format) Name() string
  • func (f *Format) Params() map[string]string
  • func (f *Format) Required() bool
  • func (f *Format) Rule() FormatRule
  • func (f *Format) Satisfies(required miruken.Constraint, ctx miruken.HandleContext) bool
• type FormatRule
• type It
  • func Into[T any](handler miruken.Handler, source any, target *T, constraints ...any) (p *promise.Promise[any], m *It, err error)
  • func Key[T any](handler miruken.Handler, key any, constraints ...any) (t T, tp *promise.Promise[T], m *It, err error)
  • func Out[T any](handler miruken.Handler, source any, constraints ...any) (t T, tp *promise.Promise[T], m *It, err error)
  • func (m *It) Dispatch(handler any, greedy bool, composer miruken.Handler) miruken.HandleResult
  • func (m *It) Key() any
  • func (m *It) Matched() *Format
  • func (m *It) Policy() miruken.Policy
  • func (m *It) SetMatched(format *Format)
  • func (m *It) Source() any
  • func (m *It) String() string
• type Strict

Constants

const (
	DirectionNone Direction = 0
	DirectionTo   Direction = 1 << iota
	DirectionFrom

	FormatRuleEquals     FormatRule = 0
	FormatRuleStartsWith FormatRule = 1 << iota
	FormatRuleEndsWith
	FormatRulePattern
	FormatRuleAll
)

Variables

var (
	ErrInvalidFormat         = errors.New("invalid format tag")
	ErrEmptyFormatIdentifier = errors.New("empty format name")
)

Functions

func All

func All[T any](
	handler miruken.Handler,
	source any,
	constraints ...any,
) (t []T, _ *promise.Promise[[]T], _ error)

Types

type Builder

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

Builder builds It callbacks.

func (*Builder) FromSource

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

func (*Builder) New

func (b *Builder) New() *It

func (*Builder) WithKey

func (b *Builder) WithKey(
	key any,
) *Builder

type Direction

type Direction uint8

Direction indicates direction of formatting.

type Format

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

Format is a Constraint for applying formatting.

func From

func From(format string, params map[string]string) *Format

From maps from a format.

func To

func To(format string, params map[string]string) *Format

To maps to a format.

func (*Format) Direction

func (f *Format) Direction() Direction

func (*Format) FlipDirection

func (f *Format) FlipDirection() *Format

func (*Format) Implied

func (f *Format) Implied() bool

func (*Format) InitWithTag

func (f *Format) InitWithTag(tag reflect.StructTag) error

func (*Format) Merge

func (f *Format) Merge(constraint miruken.Constraint) bool

func (*Format) Name

func (f *Format) Name() string

func (*Format) Params

func (f *Format) Params() map[string]string

func (*Format) Required

func (f *Format) Required() bool

func (*Format) Rule

func (f *Format) Rule() FormatRule

func (*Format) Satisfies

func (f *Format) Satisfies(required miruken.Constraint, ctx miruken.HandleContext) bool

type FormatRule

type FormatRule uint8

FormatRule describes how to interpret the format.

type It

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

It maps callbacks bivariantly.

func Into

func Into[T any](
	handler miruken.Handler,
	source any,
	target *T,
	constraints ...any,
) (p *promise.Promise[any], m *It, err error)

func Key

func Key[T any](
	handler miruken.Handler,
	key any,
	constraints ...any,
) (t T, tp *promise.Promise[T], m *It, err error)

func Out

func Out[T any](
	handler miruken.Handler,
	source any,
	constraints ...any,
) (t T, tp *promise.Promise[T], m *It, err error)

func (*It) Dispatch

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

func (*It) Key

func (m *It) Key() any

func (*It) Matched

func (m *It) Matched() *Format

func (*It) Policy

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

func (*It) SetMatched

func (m *It) SetMatched(format *Format)

func (*It) Source

func (m *It) Source() any

func (*It) String

func (m *It) String() string

type Strict

type Strict = miruken.Strict

Strict alias for mapping