action

Documentation

Index

• type Action
• type ActionFn
  • func (fn ActionFn) Run(ctx Context) (Result, error)
• type AroundFunc
• type CompositeAction
  • func Composite(actions ...Action) *CompositeAction
  • func (a *CompositeAction) AllowErrors() *CompositeAction
  • func (a *CompositeAction) Run(ctx Context) (Result, error)
• type Context
  • func NewBackgroundContext() Context
  • func NewContext(ctx context.Context) Context
• type Result
  • func (self Result) Merge(others ...Result) Result
• type WrapAction
  • func Wrap(action Action, aroundFn AroundFunc) *WrapAction
  • func (a *WrapAction) Run(ctx Context) (Result, error)

Types

type Action

type Action interface {
	Run(ctx Context) (Result, error)
}

type ActionFn

type ActionFn func(Context) (Result, error)

func (ActionFn) Run

func (fn ActionFn) Run(ctx Context) (Result, error)

type AroundFunc

type AroundFunc func(ctx Context, innerAction Action) (Result, error)

type CompositeAction

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

func Composite

func Composite(actions ...Action) *CompositeAction

func (*CompositeAction) AllowErrors

func (a *CompositeAction) AllowErrors() *CompositeAction

func (*CompositeAction) Run

func (a *CompositeAction) Run(ctx Context) (Result, error)

type Context

type Context interface {
	context.Context
	Logger() logr.Logger
	Resource() runtimeclient.Object
	WithLoggerValues(values ...interface{}) Context
	WithResource(obj runtimeclient.Object) Context
}

Context used to pass information between actions

func NewBackgroundContext

func NewBackgroundContext() Context

func NewContext

func NewContext(ctx context.Context) Context

type Result

type Result struct {
	Requeue      bool
	RequeueAfter time.Duration
	Halt         bool
}

func (Result) Merge

func (self Result) Merge(others ...Result) Result

type WrapAction

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

func Wrap

func Wrap(action Action, aroundFn AroundFunc) *WrapAction

func (*WrapAction) Run

func (a *WrapAction) Run(ctx Context) (Result, error)