router #

fn extract_route_path(path string) !(string, string, string)

extract_route_path returns the name, the parameter name (if present), and the remaining children route paths

fn get_ctx(r &ctx.Req) voidptr

get_ctx accesses the global context

fn new() Router

type GroupCallbackFn = fn (mut group map[string]&Route)

fn (mut routes map[string]&Route) route(method Method, path string, handlers ...ctx.HandlerFunc)

route creates a new route based on the given method, path, and the handlers. See router.Method for the list of available methods.

fn (mut routes map[string]&Route) group(path string, callback GroupCallbackFn)

group adds a series of routes into the desired prefix

fn (mut routes map[string]&Route) use(middlewares ...ctx.MiddlewareFunc)

enum Method {
	get
	post
	patch
	put
	delete
	options
}

List of supported HTTP methods.

struct Route {
	name       string
	param_name string
	method     Method
	kind       Kind
mut:
	children    map[string]&Route
	methods     map[string][]ctx.HandlerFunc
	middlewares []ctx.MiddlewareFunc
}

fn (r &Route) str() string

empty str to avoid cgen error

fn (routes map[string]&Route) find(method string, path string) !(map[string]string, []ctx.MiddlewareFunc, []ctx.HandlerFunc)

find searches the matching route and returns the injected params data and the route handlers.

struct Router {
pub mut:
	on_error ctx.HandlerFunc = ctx.error_route
mut:
	routes      map[string]&Route
	middlewares []ctx.MiddlewareFunc
	ctx         context.Context = context.todo() // TODO: remove in the near future
}

fn (r Router) receive(method string, path string, raw_headers []string, body []u8) (int, []u8, []u8)

fn (r Router) respond_error(code int) []u8

fn (mut r Router) inject(data voidptr)

fn (mut r Router) inject_context(ctx_ context.Context)

inject_context injects the context to the handler context.

Todo: to be removed in the future. must be in a form of a middleware instead.

fn (mut r Router) route(method Method, path string, handlers ...ctx.HandlerFunc)

route is a shortcut method to r.routes.route method

fn (mut r Router) group(prefix string, callback GroupCallbackFn)

group is a shortcut method to r.routes.group method

fn (mut r Router) use(handlers ...ctx.MiddlewareFunc)

use registers handlers as app-wide middlewares