steps

Documentation

Index

• Constants
• Variables
• type NewStepFunc
  • func (f NewStepFunc[T, U]) NewStep() (Step[T, U], error)
• type Step
• type StepFactory
• type StepMetadata
  • func (sm StepMetadata) MarshalZerologObject(e *zerolog.Event)
  • func (sm *StepMetadata) ToMap() map[string]interface{}
• type StepResult
  • func Bind[T any, U any](ctx context.Context, m StepResult[T], step Step[T, U]) StepResult[U]
• type StepResultImpl
  • func NewStepResult[T any](value <-chan helpers.Result[T], options ...StepResultOption[T]) *StepResultImpl[T]
  • func Reject[T any](err error, options ...StepResultOption[T]) *StepResultImpl[T]
  • func Resolve[T any](value T, options ...StepResultOption[T]) *StepResultImpl[T]
  • func ResolveNone[T any](options ...StepResultOption[T]) *StepResultImpl[T]
  • func (m *StepResultImpl[T]) Cancel()
  • func (m *StepResultImpl[T]) GetChannel() <-chan helpers.Result[T]
  • func (m *StepResultImpl[T]) GetMetadata() *StepMetadata
  • func (m *StepResultImpl[T]) Return() []helpers.Result[T]
• type StepResultOption
  • func WithCancel[T any](cancel func()) StepResultOption[T]
  • func WithMetadata[T any](metadata *StepMetadata) StepResultOption[T]
  • func WithMetadataFunc[T any](metadataFunc func() *StepMetadata) StepResultOption[T]

Constants

const MetadataSettingsSlug = "settings"

Variables

var ErrMissingClientAPIKey = errors.New("missing client settings api key")

var ErrMissingClientSettings = errors.New("missing client settings")

Types

type NewStepFunc

type NewStepFunc[T any, U any] func() (Step[T, U], error)

func (NewStepFunc[T, U]) NewStep

func (f NewStepFunc[T, U]) NewStep() (Step[T, U], error)

type Step

type Step[T any, U any] interface {
	// Start gets called multiple times for the same Step, once per incoming value,
	// since StepResult is also the list monad (ie., supports multiple values)
	Start(ctx context.Context, input T) (StepResult[U], error)
	AddPublishedTopic(publisher message.Publisher, topic string) error
}

Step is the generalization of a lambda function, with cancellation and closing to allow it to own resources.

type StepFactory

type StepFactory[T any, U any] interface {
	NewStep() (Step[T, U], error)
}

type StepMetadata

type StepMetadata struct {
	StepID     uuid.UUID `json:"step_id"`
	Type       string    `json:"type"`
	InputType  string    `json:"input_type"`
	OutputType string    `json:"output_type"`

	Metadata map[string]interface{} `json:"meta"`
}

func (StepMetadata) MarshalZerologObject

func (sm StepMetadata) MarshalZerologObject(e *zerolog.Event)

func (*StepMetadata) ToMap

func (sm *StepMetadata) ToMap() map[string]interface{}

type StepResult

type StepResult[T any] interface {
	Return() []helpers.Result[T]
	GetChannel() <-chan helpers.Result[T]
	// Cancel can't fail
	Cancel()
	GetMetadata() *StepMetadata
}

func Bind

func Bind[T any, U any](
	ctx context.Context,
	m StepResult[T],
	step Step[T, U],
) StepResult[U]

Bind is the monadic bind operator for StepResult. It takes a step result, a step (which is just a lambda turned into a struct) iterates over the results in the StepResult, and starts the Step for each value.

type StepResultImpl

type StepResultImpl[T any] struct {
	// contains filtered or unexported fields
}

func NewStepResult

func NewStepResult[T any](
	value <-chan helpers.Result[T],
	options ...StepResultOption[T],
) *StepResultImpl[T]

func Reject

func Reject[T any](err error, options ...StepResultOption[T]) *StepResultImpl[T]

func Resolve

func Resolve[T any](value T, options ...StepResultOption[T]) *StepResultImpl[T]

func ResolveNone

func ResolveNone[T any](options ...StepResultOption[T]) *StepResultImpl[T]

func (*StepResultImpl[T]) Cancel

func (m *StepResultImpl[T]) Cancel()

func (*StepResultImpl[T]) GetChannel

func (m *StepResultImpl[T]) GetChannel() <-chan helpers.Result[T]

func (*StepResultImpl[T]) GetMetadata

func (m *StepResultImpl[T]) GetMetadata() *StepMetadata

func (*StepResultImpl[T]) Return

func (m *StepResultImpl[T]) Return() []helpers.Result[T]

type StepResultOption

type StepResultOption[T any] func(*StepResultImpl[T])

func WithCancel

func WithCancel[T any](cancel func()) StepResultOption[T]

func WithMetadata

func WithMetadata[T any](metadata *StepMetadata) StepResultOption[T]

func WithMetadataFunc

func WithMetadataFunc[T any](metadataFunc func() *StepMetadata) StepResultOption[T]