chain

Documentation

Index

• Variables
• type Chain
  • func (chain *Chain) Handle(tmp Temporary) error
  • func (chain *Chain) Use(handlers ...Handler) error
• type Context
• type Handler
• type Temporary
• type UnaryHandler
• type UnaryInterceptor
  • func ChainUnaryInterceptors[T any](interceptors []UnaryInterceptor[T]) UnaryInterceptor[T]

Variables

var (
	ErrTooManyHandle = errors.Errorf("too many handlers, at most '%d' handlers is allowed", abortIndex)
	ErrNoHandle      = errors.New("chain has no handlers, forget call Use()?")
)

Types

type Chain

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

Chain represents a chain of handlers.

func (*Chain) Handle

func (chain *Chain) Handle(tmp Temporary) error

Handle executes the chain of handlers.

func (*Chain) Use

func (chain *Chain) Use(handlers ...Handler) error

Use adds handlers to the chain.

type Context

type Context interface {
	Temporary
	Abort()                   // Abort the chain execution.
	AbortWithError(err error) // Abort the chain execution with a custom error.
	IsAborted() bool          // Check if the chain execution is aborted.
	Next()                    // Continue to the next handler in the chain.
}

Context defines the interface for the context passed through the chain.

type Handler

type Handler interface {
	Execute(ctx Context)
}

Handler defines the interface for a chain handler.

type Temporary

type Temporary interface {
	Set(key string, value any)  // Set a value in the context.
	Get(key string) (any, bool) // Get a value from the context.
	Request() any               // Get the request associated with the context.
}

type UnaryHandler

type UnaryHandler[T any] func(ctx context.Context, in T) (any, error)

type UnaryInterceptor

type UnaryInterceptor[T any] func(ctx context.Context, in T, handler UnaryHandler[T]) (resp any, err error)

func ChainUnaryInterceptors

func ChainUnaryInterceptors[T any](interceptors []UnaryInterceptor[T]) UnaryInterceptor[T]