steps

Documentation

Index

• Variables
• type Step
• type StepFactory
• 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]) *StepResultImpl[T]
  • func Reject[T any](err error) *StepResultImpl[T]
  • func Resolve[T any](value T) *StepResultImpl[T]
  • func ResolveNone[T any]() *StepResultImpl[T]
  • func (m *StepResultImpl[T]) GetChannel() <-chan helpers.Result[T]
  • func (m *StepResultImpl[T]) Return() []helpers.Result[T]

Variables

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

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

Types

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)
}

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 StepResult

type StepResult[T any] interface {
	Return() []helpers.Result[T]
	GetChannel() <-chan helpers.Result[T]
}

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]) *StepResultImpl[T]

func Reject

func Reject[T any](err error) *StepResultImpl[T]

func Resolve

func Resolve[T any](value T) *StepResultImpl[T]

func ResolveNone

func ResolveNone[T any]() *StepResultImpl[T]

func (*StepResultImpl[T]) GetChannel

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

func (*StepResultImpl[T]) Return

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