chevron

type EmptySpec struct{}

type Handler func(context.Context, *http.Request, nacelle.Logger) response.Response

type Method int

type Middleware interface {
	// Convert applies the middleware transformation to a handler. If
	// the middleware is supplied invalid arguments it may return an
	// error at the time of decoration.
	Convert(Handler) (Handler, error)
}

type MiddlewareConfigFunc func(handlerMap) error

type MiddlewareFunc func(Handler) (Handler, error)

type Resource interface {
	// Handle is invoked when the resource is requested, regardless of the
	// HTTP method.
	Handle(context.Context, *http.Request, nacelle.Logger) response.Response
}

type ResourceSpec interface {
	// Get is the handler invoked for the GET HTTP method.
	Get(context.Context, *http.Request, nacelle.Logger) response.Response

	// Options is the handler invoked for the OPTIONS HTTP method.
	Options(context.Context, *http.Request, nacelle.Logger) response.Response

	// Post is the handler invoked for the POST HTTP method.
	Post(context.Context, *http.Request, nacelle.Logger) response.Response

	// Put is the handler invoked for the PUT HTTP method.
	Put(context.Context, *http.Request, nacelle.Logger) response.Response

	// Patch is the handler invoked for the PATCH HTTP method.
	Patch(context.Context, *http.Request, nacelle.Logger) response.Response

	// Delete is the handler invoked for the DELETE HTTP method.
	Delete(context.Context, *http.Request, nacelle.Logger) response.Response
}

type RouteInitializer interface {
	// Init registers resources and middleware to the router.
	Init(config nacelle.Config, router Router) error
}

type RouteInitializerFunc func(config nacelle.Config, router Router) error

type Router interface {
	http.Handler

	// AddMiddleware registers middleware for all resources registered after
	// the invocation of this method.
	AddMiddleware(middleware Middleware)

	// Register creates a resource from the given resource spec and set of
	// middleware instances and registers it to the given URL pattern.
	Register(url string, spec ResourceSpec, configs ...MiddlewareConfigFunc) error

	// MustRegister calls Register and panics on error.
	MustRegister(url string, spec ResourceSpec, configs ...MiddlewareConfigFunc)

	RegisterHandler(url string, handler http.Handler)
}

type RouterConfigFunc func(*router)

type ServerInitializer struct {
	Services nacelle.ServiceContainer `service:"container"`
	Logger   nacelle.Logger           `service:"logger"`
	// contains filtered or unexported fields
}