api

Documentation

Overview

Package api provides types used by controller/server-component packages.

Index

• type RoutableFunc
• type RoutableFuncWrapper
  • func ComposeWrappers(wraps ...RoutableFuncWrapper) RoutableFuncWrapper

Types

type RoutableFunc

type RoutableFunc func(ctx context.Context, opts interface{}) (interface{}, error)

A RoutableFunc calls an API method (sometimes via a wrapped RoutableFunc) that has real argument types.

(It is used by ctrlctx to manage database transactions, so moving it to the router package would cause a circular dependency router->arvadostest->ctrlctx->router.)

type RoutableFuncWrapper

type RoutableFuncWrapper func(RoutableFunc) RoutableFunc

func ComposeWrappers

func ComposeWrappers(wraps ...RoutableFuncWrapper) RoutableFuncWrapper

ComposeWrappers (w1, w2, w3, ...) returns a RoutableFuncWrapper that composes w1, w2, w3, ... such that w1 is the outermost wrapper.