api

type ConcurrentBatch ¶

type ConcurrentBatch struct {
	Requests []any
}

ConcurrentBatch represents a batch of requests to execute concurrently. The operation returns after all requests are completed and includes all successes and failures.

type Content ¶ added in v0.26.0

type Content interface {
	MediaType() string
	Metadata() map[string]any
	Body() any
}

Content is information produced or consumed by an api.

type GoPolymorphism ¶ added in v0.24.0

type GoPolymorphism struct{}

GoPolymorphism provides type information using GO types names.

func (m *GoPolymorphism) Dynamic(
	_ *struct{ creates.Strict }, create *creates.It,
	ctx miruken.HandleContext,
) any

func (m *GoPolymorphism) Static(
	_ *struct {
		creates.Strict
		_ creates.It `key:"bool"`
		_ creates.It `key:"int"`
		_ creates.It `key:"int8"`
		_ creates.It `key:"int16"`
		_ creates.It `key:"int32"`
		_ creates.It `key:"int64"`
		_ creates.It `key:"uint"`
		_ creates.It `key:"uint8"`
		_ creates.It `key:"uint16"`
		_ creates.It `key:"uint32"`
		_ creates.It `key:"uint64"`
		_ creates.It `key:"float32"`
		_ creates.It `key:"float64"`
		_ creates.It `key:"string"`
		_ creates.It `key:"interface {}"`
		_ creates.It `key:"[]bool"`
		_ creates.It `key:"[]int"`
		_ creates.It `key:"[]int8"`
		_ creates.It `key:"[]int16"`
		_ creates.It `key:"[]int32"`
		_ creates.It `key:"[]int64"`
		_ creates.It `key:"[]uint"`
		_ creates.It `key:"[]uint8"`
		_ creates.It `key:"[]uint16"`
		_ creates.It `key:"[]uint32"`
		_ creates.It `key:"[]uint64"`
		_ creates.It `key:"[]float32"`
		_ creates.It `key:"[]float64"`
		_ creates.It `key:"[]string"`
		_ creates.It `key:"[]interface {}"`
	}, create *creates.It,
) any

func (m *GoPolymorphism) TypeInfo(
	_ *struct {
		maps.Format `to:"type:info"`
	}, it *maps.It,
) (TypeFieldInfo, error)

type Installer ¶

type Installer struct{}

Installer enables core api support.

func (i *Installer) Install(b *setup.Builder) error

type Late ¶ added in v0.30.28

type Late struct {
	Value any
}

Late is a container for late polymorphic results. It is used be serializers to explicitly request polymorphic behavior and avoid circular calls with any type.

type MalformedErrorError ¶ added in v0.22.0

type MalformedErrorError struct {
	Culprit any
}

MalformedErrorError reports an invalid error payload.

func (e *MalformedErrorError) Error() string

type Message ¶ added in v0.11.0

type Message struct {
	Payload any
}

Message is an envelope for polymorphic payloads.

type MultipartMapper ¶ added in v0.25.0

type MultipartMapper struct{}

MultipartMapper reads and writes 'multipart/*' mime messages from a PartContainer.

func (m *MultipartMapper) Read(
	_ *struct {
		maps.Format `from:"/multipart//"`
	}, reader io.Reader,
	it *maps.It,
	ctx miruken.HandleContext,
) (Message, error)

func (m *MultipartMapper) Write(
	_ *struct {
		maps.Format `to:"/multipart//"`
	}, msg Message,
	it *maps.It,
	ctx miruken.HandleContext,
) (io.Writer, error)

func (m *MultipartMapper) WriteParts(
	_ *struct {
		maps.Format `to:"/multipart//"`
	}, pc PartContainer,
	it *maps.It,
	ctx miruken.HandleContext,
) (io.Writer, error)

type Options ¶ added in v0.18.0

type Options struct {
	Polymorphism   miruken.Option[Polymorphism]
	TypeInfoFormat string
	TypeFieldValue string
}

Options control api message processing.

type Part ¶ added in v0.25.0

type Part interface {
	Content
	Filename() string
}

Part represents a piece of a message. Part can be used in a PartContainer or independently to control message encoding.

type PartBuilder ¶ added in v0.25.0

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

PartBuilder builds a message Part.

func (b *PartBuilder) Body(
	body any,
) *PartBuilder

func (b *PartBuilder) Build() Part

func (b *PartBuilder) Filename(
	filename string,
) *PartBuilder

func (b *PartBuilder) MediaType(
	mediaType string,
) *PartBuilder

func (b *PartBuilder) Metadata(
	metadata map[string]any,
) *PartBuilder

func (b *PartBuilder) MetadataStrings(
	metadata map[string][]string,
) *PartBuilder

type PartContainer ¶ added in v0.25.0

type PartContainer interface {
	Content
	Parts() map[string][]Part
	MainPart() Part
}

PartContainer stores all the Part's of a message. The main part is typically the message payload.

type PassThroughRouter ¶

type PassThroughRouter struct{}

func (p *PassThroughRouter) Pass(
	_ *struct {
		handles.It
		miruken.SkipFilters
		Routes `scheme:"pass-through"`
	}, routed Routed,
	composer miruken.Handler,
) (any, miruken.HandleResult)

type Polymorphism ¶ added in v0.20.0

type Polymorphism uint8

Polymorphism enumerates how type information should be included in messages.

const (
	PolymorphismNone Polymorphism = 0
	PolymorphismRoot Polymorphism = 1 << iota
)

type Published ¶

type Published struct {
	Message any
}

Published marks a message to be published to all consumers.

type ReadPartsBuilder ¶ added in v0.25.0

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

ReadPartsBuilder builds a PartContainer for reading Part's.

func (b *ReadPartsBuilder) AddPart(
	key string,
	part Part,
) *ReadPartsBuilder

func (b *ReadPartsBuilder) AddParts(
	parts map[string][]Part,
) *ReadPartsBuilder

func (b *ReadPartsBuilder) Build() PartContainer

func (b *ReadPartsBuilder) MainPart(
	main Part,
) *ReadPartsBuilder

func (b *ReadPartsBuilder) Metadata(
	metadata map[string]any,
) *ReadPartsBuilder

func (b *ReadPartsBuilder) NewPart() *PartBuilder

type RouteReply ¶

type RouteReply struct {
	Uri       string
	Responses []any
}

RouteReply holds the responses for a route.

type Routed ¶

type Routed struct {
	Message any
	Route   string
}

Routed wraps a message with route information.

func RouteTo(message any, route string) Routed

type Routes ¶

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

Routes is a FilterProvider for routing.

func (r *Routes) AppliesTo(
	callback miruken.Callback,
) bool

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

func (r *Routes) InitWithTag(tag reflect.StructTag) error

func (r *Routes) Required() bool

func (r *Routes) Satisfies(routed Routed) bool

type ScheduledResult ¶

type ScheduledResult struct {
	Responses []either.Monad[error, any]
}

ScheduledResult represents the results of a scheduled request. The result is either an error (if fails) or success value.

type Scheduler ¶

type Scheduler struct{}

Scheduler performs the scheduling of requests.

func (s *Scheduler) Concurrent(
	_ *handles.It, concurrent ConcurrentBatch,
	composer miruken.Handler,
) *promise.Promise[ScheduledResult]

func (s *Scheduler) Constructor(
	_ *struct {
		provides.It
		provides.Single
	},
)

func (s *Scheduler) New(
	_ *struct {
		_ creates.It `key:"api.ConcurrentBatch"`
		_ creates.It `key:"api.SequentialBatch"`
		_ creates.It `key:"api.ScheduledResult"`
		_ creates.It `key:"api.Published"`
	}, create *creates.It,
) any

func (s *Scheduler) Publish(
	_ *handles.It, publish Published,
	composer miruken.Handler,
) (p *promise.Promise[any], err error)

func (s *Scheduler) Sequential(
	_ *handles.It, sequential SequentialBatch,
	composer miruken.Handler,
) *promise.Promise[ScheduledResult]

type SequentialBatch ¶

type SequentialBatch struct {
	Requests []any
}

SequentialBatch represents a batch of requests to execute sequentially. The operation aborts after the first failure and returns the successfully completed responses and first failure.

type Stash ¶

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

Stash is a transient storage of data.

func NewStash(root bool) *Stash

func (s *Stash) Drop(
	_ *handles.It, drop *stashDrop,
)

func (s *Stash) Get(
	_ *handles.It, get *stashGet,
) miruken.HandleResult

func (s *Stash) NoConstructor()

func (s *Stash) Provide(
	_ *struct{ provides.Strict }, p *provides.It,
) any

func (s *Stash) Put(
	_ *handles.It, put *stashPut,
)

type Surrogate ¶ added in v0.22.0

type Surrogate interface {
	Original(miruken.Handler) (any, error)
}

Surrogate replaces a value with another for api transmission.

type TypeFieldInfo ¶ added in v0.16.0

type TypeFieldInfo struct {
	TypeField   string
	TypeValue   string
	ValuesField string
}

TypeFieldInfo defines the type information for polymorphic messages.

type UnknownTypeIdError ¶ added in v0.21.0

type UnknownTypeIdError struct {
	TypeId string
	Cause  error
}

UnknownTypeIdError reports an invalid type discriminator.

func (e *UnknownTypeIdError) Error() string

func (e *UnknownTypeIdError) Unwrap() error

type WritePartsBuilder ¶ added in v0.25.0

type WritePartsBuilder struct {
	ReadPartsBuilder
}

WritePartsBuilder builds a PartContainer for writing Part's.

func (b *WritePartsBuilder) Build() PartContainer

func (b *WritePartsBuilder) MediaType(
	mediaType string,
) *WritePartsBuilder