router

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2025 License: MIT Imports: 1 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Route

type Route interface {
	// Handler returns the function the route applies
	Handler() http.HandlerFunc
	// Method returns the http method the route corresponds to
	Method() string
	// Path returns the subpath where the route responds
	Path() string
	// Status returns whether the route is enabled
	Status() bool
	// Experimental returns whether the route is experimental
	Experimental() bool
}

func NewDeleteRoute

func NewDeleteRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewDeleteRoute initializes a new route with the http method DELETE.

func NewGetRoute

func NewGetRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewGetRoute initializes a new route with the http method GET.

func NewHeadRoute

func NewHeadRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewHeadRoute initializes a new route with the http method HEAD.

func NewOptionsRoute

func NewOptionsRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewOptionsRoute initializes a new route with the http method OPTIONS.

func NewPostRoute

func NewPostRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewPostRoute initializes a new route with the http method POST.

func NewPutRoute

func NewPutRoute(path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewPutRoute initializes a new route with the http method PUT.

func NewRoute

func NewRoute(method string, path string, status bool, experimental bool, handler http.HandlerFunc, opts ...RouteWrapper) Route

NewRoute initializes a new local route for the router.

type RouteWrapper

type RouteWrapper func(r Route) Route

RouteWrapper wraps a route with extra functionality. It is passed in when creating a new route.

type Router

type Router interface {
	// Returns the list of all routes
	Routes() []Route
	// Is the router enabled
	Status() bool
	// The router prefix
	Prefix() string
}

func NewRouter

func NewRouter(prefix string, routes []Route, status bool, opts ...RouterWrapper) Router

NewRouter initializes a new local router for the system.

type RouterWrapper

type RouterWrapper func(r Router) Router

RouterWrapper wraps a router with extra functionality . It is passed in when creating a new router.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL