droplet

README

droplet

let your code more extensible, build server fast

Intall

go get github.com/shiningrush/droplet

Documentation

Index

• Variables
• func NewContext() *emptyContext
• type BasePipe
  • func NewPipe() *BasePipe
  • func (p *BasePipe) Add(mw Middleware) *BasePipe
  • func (p *BasePipe) AddIf(mw Middleware, predicate bool) *BasePipe
  • func (p *BasePipe) AddRange(mws []Middleware) *BasePipe
  • func (p *BasePipe) Run(handler Handler, opts ...SetRunOpt) (interface{}, error)
  • func (p *BasePipe) SetOrchestrator(o Orchestrator) *BasePipe
• type Context
• type GlobalOpt
• type Handler
• type HttpFileResponse
• type HttpResponse
• type Middleware
  • func NewHandlerMiddleware(handler Handler) Middleware
• type MockMiddleware
  • func (_m *MockMiddleware) Handle(ctx Context) error
  • func (_m *MockMiddleware) Priority() int
  • func (_m *MockMiddleware) SetNext(next Middleware)
• type Orchestrator
• type RunOpt
• type SetRunOpt
  • func InitContext(ctx Context) SetRunOpt

Variables

var (
	Option = GlobalOpt{
		HeaderKeyRequestID: "X-Request-ID",
		ResponseNewFunc: func() HttpResponse {
			return &data.Response{}
		},
	}
)

Functions

func NewContext

func NewContext() *emptyContext

Types

type BasePipe

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

func NewPipe

func NewPipe() *BasePipe

func (*BasePipe) Add

func (p *BasePipe) Add(mw Middleware) *BasePipe

func (*BasePipe) AddIf

func (p *BasePipe) AddIf(mw Middleware, predicate bool) *BasePipe

func (*BasePipe) AddRange

func (p *BasePipe) AddRange(mws []Middleware) *BasePipe

func (*BasePipe) Run

func (p *BasePipe) Run(handler Handler, opts ...SetRunOpt) (interface{}, error)

func (*BasePipe) SetOrchestrator

func (p *BasePipe) SetOrchestrator(o Orchestrator) *BasePipe

type Context

type Context interface {
	Context() context.Context
	SetContext(context.Context)
	Get(key string) interface{}
	GetString(key string) string
	Set(key string, value interface{})
	SetInput(interface{})
	Input() interface{}
	SetOutput(interface{})
	Output() interface{}
	SetPath(path string)
	Path() string
}

type GlobalOpt

type GlobalOpt struct {
	HeaderKeyRequestID string
	ResponseNewFunc    func() HttpResponse
	Orchestrator       Orchestrator
}

type Handler

type Handler func(ctx Context) (interface{}, error)

type HttpFileResponse

type HttpFileResponse interface {
	Get() (name, contentType string, content []byte)
}

type HttpResponse

type HttpResponse interface {
	Set(code int, msg, reqId string, data interface{})
}

type Middleware

type Middleware interface {
	SetNext(next Middleware)
	Handle(ctx Context) error
}

func NewHandlerMiddleware

func NewHandlerMiddleware(handler Handler) Middleware

type MockMiddleware

type MockMiddleware struct {
	mock.Mock
}

MockMiddleware is an autogenerated mock type for the Middleware type

func (*MockMiddleware) Handle

func (_m *MockMiddleware) Handle(ctx Context) error

Handle provides a mock function with given fields: ctx

func (*MockMiddleware) Priority

func (_m *MockMiddleware) Priority() int

Priority provides a mock function with given fields:

func (*MockMiddleware) SetNext

func (_m *MockMiddleware) SetNext(next Middleware)

SetNext provides a mock function with given fields: next

type Orchestrator

type Orchestrator func(mws []Middleware) []Middleware

type RunOpt

type RunOpt struct {
	InitContext Context
}

type SetRunOpt

type SetRunOpt func(opt *RunOpt)

func InitContext

func InitContext(ctx Context) SetRunOpt