inbuilt

Documentation

Index

• Constants
• type Resource
  • func (r Resource) Catch(prefix string, handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Connect(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Delete(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Get(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Head(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Options(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Patch(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Post(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Put(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Route(method method.Method, fun types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Static(prefix, root string) Resource
  • func (r Resource) Trace(handler types.Handler, mwares ...types.Middleware) Resource
  • func (r Resource) Use(middlewares ...types.Middleware) Resource
• type Router
  • func New() *Router
  • func (r *Router) Catch(prefix string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Connect(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Delete(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Get(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Group(prefix string) *Router
  • func (r *Router) Head(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) OnError(request *http.Request, err error) *http.Response
  • func (r *Router) OnRequest(request *http.Request) *http.Response
  • func (r *Router) OnStart() error
  • func (r *Router) Options(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Patch(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Post(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Put(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Resource(path string) Resource
  • func (r *Router) Route(method method.Method, path string, handlerFunc types.Handler, ...) *Router
  • func (r *Router) RouteError(handler types.Handler, codes ...status.Code) *Router
  • func (r *Router) Static(prefix, root string, mwares ...types.Middleware) *Router
  • func (r *Router) Trace(path string, handler types.Handler, middlewares ...types.Middleware) *Router
  • func (r *Router) Use(middlewares ...types.Middleware) *Router

Constants

const AllErrors = status.Code(0)

AllErrors is used to be passed into Router.RouteError, indicating by that, that the handler must handle ALL errors (if concrete error's handler won't override it)

Types

type Resource

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

Resource is just a wrapper of a group for some resource, allowing to attach multiple methods (and pointed-applied middlewares) to some single resource in a bit more convenient way than ordinary groups do. Actually, the only point of this object is to wrap a group to bypass an empty string into it as a path

func (Resource) Catch

func (r Resource) Catch(prefix string, handler types.Handler, mwares ...types.Middleware) Resource

Catch registers a catcher. A catcher is a handler, that is being called if requested path is not found, and it starts with a defined prefix

func (Resource) Connect

func (r Resource) Connect(handler types.Handler, mwares ...types.Middleware) Resource

Connect registers a handler for CONNECT-requests

func (Resource) Delete

func (r Resource) Delete(handler types.Handler, mwares ...types.Middleware) Resource

Delete registers a handler for DELETE-requests

func (Resource) Get

func (r Resource) Get(handler types.Handler, mwares ...types.Middleware) Resource

Get registers a handler for GET-requests

func (Resource) Head

func (r Resource) Head(handler types.Handler, mwares ...types.Middleware) Resource

Head registers a handler for HEAD-requests

func (Resource) Options

func (r Resource) Options(handler types.Handler, mwares ...types.Middleware) Resource

Options registers a handler for OPTIONS-requests

func (Resource) Patch

func (r Resource) Patch(handler types.Handler, mwares ...types.Middleware) Resource

Patch registers a handler for PATCH-requests

func (Resource) Post

func (r Resource) Post(handler types.Handler, mwares ...types.Middleware) Resource

Post registers a handler for POST-requests

func (Resource) Put

func (r Resource) Put(handler types.Handler, mwares ...types.Middleware) Resource

Put registers a handler for PUT-requests

func (Resource) Route

func (r Resource) Route(method method.Method, fun types.Handler, mwares ...types.Middleware) Resource

Route is a shortcut to group.Route, providing the extra empty path to the call

func (Resource) Static

func (r Resource) Static(prefix, root string) Resource

Static adds a catcher of prefix, that automatically returns files from defined root directory

func (Resource) Trace

func (r Resource) Trace(handler types.Handler, mwares ...types.Middleware) Resource

Trace registers a handler for TRACE-requests

func (Resource) Use

func (r Resource) Use(middlewares ...types.Middleware) Resource

Use applies middlewares to the resource, wrapping all the already registered and registered in future handlers

type Router

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

Router is a built-in implementation of router.Router interface that provides some basic router features like middlewares, groups, dynamic routing, error handlers, and some implicit things like calling GET-handlers for HEAD-requests, or rendering TRACE-responses automatically in case no handler is registered

func New

func New() *Router

New constructs a new instance of inbuilt router

func (*Router) Catch

func (r *Router) Catch(prefix string, handler types.Handler, middlewares ...types.Middleware) *Router

Catch registers a catcher. A catcher is a handler, that is being called if requested path is not found, and it starts with a defined prefix

func (*Router) Connect

func (r *Router) Connect(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Connect is a shortcut for registering CONNECT-requests

func (*Router) Delete

func (r *Router) Delete(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Delete is a shortcut for registering DELETE-requests

func (*Router) Get

func (r *Router) Get(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Get is a shortcut for registering GET-requests

func (*Router) Group

func (r *Router) Group(prefix string) *Router

Group creates a new router with pre-defined prefix for all paths. It'll automatically be merged into the head router on server start. Middlewares, applied on this router, will not affect the head router, but initially head router's middlewares will be inherited and will be called in the first order. Registering new error handlers will result in affecting error handlers among ALL the existing groups, including head router

func (*Router) Head

func (r *Router) Head(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Head is a shortcut for registering HEAD-requests

func (*Router) OnError

func (r *Router) OnError(request *http.Request, err error) *http.Response

OnError tries to find a handler for the error, in case it can't - simply request.Respond().WithError(...) will be returned

func (*Router) OnRequest

func (r *Router) OnRequest(request *http.Request) *http.Response

OnRequest routes the request

func (*Router) OnStart

func (r *Router) OnStart() error

OnStart composes all the registered handlers with middlewares

func (*Router) Options

func (r *Router) Options(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Options is a shortcut for registering OPTIONS-requests

func (*Router) Patch

func (r *Router) Patch(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Patch is a shortcut for registering PATCH-requests

func (*Router) Post

func (r *Router) Post(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Post is a shortcut for registering POST-requests

func (*Router) Put

func (r *Router) Put(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Put is a shortcut for registering PUT-requests

func (*Router) Resource

func (r *Router) Resource(path string) Resource

Resource returns a new Resource object for a provided resource path

func (*Router) Route

func (r *Router) Route(
	method method.Method, path string, handlerFunc types.Handler,
	middlewares ...types.Middleware,
) *Router

Route is a base method for registering handlers

func (*Router) RouteError

func (r *Router) RouteError(handler types.Handler, codes ...status.Code) *Router

RouteError adds an error handler for a corresponding HTTP error code.

Note: error codes are only 4xx and 5xx. Registering for other codes will result in panicking.

The following error codes may be handled: - AllErrors - status.BadRequest - status.NotFound - status.MethodNotAllowed - status.RequestEntityTooLarge - status.CloseConnection - status.RequestURITooLong - status.HeaderFieldsTooLarge - status.HTTPVersionNotSupported - status.UnsupportedMediaType - status.NotImplemented - status.RequestTimeout

You can set your own handler and override default response.

WARNING: calling this method from groups will affect ALL routers, including root

func (*Router) Static

func (r *Router) Static(prefix, root string, mwares ...types.Middleware) *Router

Static adds a catcher of prefix, that automatically returns files from defined root directory

func (*Router) Trace

func (r *Router) Trace(path string, handler types.Handler, middlewares ...types.Middleware) *Router

Trace is a shortcut for registering TRACE-requests

func (*Router) Use

func (r *Router) Use(middlewares ...types.Middleware) *Router

Use adds middlewares into the global list of a group's middlewares. But they will be applied only after the server will be started