routing

Documentation

Index

• func GetParameter(c context.Context, key string) (string, bool)
• func WithParameters(c context.Context, parameters Parameters) context.Context
• type Filter
• type FilterChain
  • func (chain FilterChain) Build(handler http.HandlerFunc) http.HandlerFunc
  • func (chain FilterChain) Extend(chain2 FilterChain) FilterChain
• type Methods
  • func (methods Methods) Compare(method string) (match bool)
  • func (methods Methods) Extend(methods2 Methods) Methods
• type Parameters
  • func GetParameters(c context.Context) Parameters
• type Route
• type RouteBuilder
  • func Delete(path string) RouteBuilder
  • func Filtering(filter Filter) RouteBuilder
  • func Get(path string) RouteBuilder
  • func Method(methods ...string) RouteBuilder
  • func NewRouteBuilder() RouteBuilder
  • func Patch(path string) RouteBuilder
  • func Path(path string) RouteBuilder
  • func Post(path string) RouteBuilder
  • func Put(path string) RouteBuilder
  • func (builder RouteBuilder) Filter(filter Filter) RouteBuilder
  • func (builder RouteBuilder) Method(methods ...string) RouteBuilder
  • func (builder RouteBuilder) Path(path string) RouteBuilder
• type Router
  • func NewRouter(configurations ...RoutingConsumer) *Router
  • func (r *Router) Handle(routeBuilder RouteBuilder, handler http.Handler)
  • func (r *Router) HandleFunc(routeBuilder RouteBuilder, handlerFunc http.HandlerFunc)
  • func (r *Router) Route(matcher RouteBuilder, configurations ...RoutingConsumer) Routing
  • func (r *Router) ServeHTTP(writer http.ResponseWriter, request *http.Request)
• type Routing
• type RoutingConsumer
  • func DefaultNotFound() RoutingConsumer
• type Segment
  • func (seg Segment) IsGlobalWildcard() bool
  • func (seg Segment) IsParam() (is bool, name string)
  • func (seg Segment) IsWildcard() bool
  • func (seg Segment) Print(params map[string]string) string
• type Segments
  • func NewSegments(template string) (segments Segments)
  • func (segments Segments) Compare(path UriPath) (match bool, matched UriPath, params Parameters)
  • func (segments Segments) Extend(path Segments) Segments
  • func (segments Segments) Print(params map[string]string) string
  • func (segments Segments) String() string
• type UriPath
  • func NewUriPath(path string) UriPath

Functions

func GetParameter

func GetParameter(c context.Context, key string) (string, bool)

func WithParameters

func WithParameters(c context.Context, parameters Parameters) context.Context

Types

type Filter

type Filter func(w http.ResponseWriter, r *http.Request, handlerFunc http.HandlerFunc)

type FilterChain

type FilterChain []Filter

func (FilterChain) Build

func (chain FilterChain) Build(handler http.HandlerFunc) http.HandlerFunc

func (FilterChain) Extend

func (chain FilterChain) Extend(chain2 FilterChain) FilterChain

type Methods

type Methods []string

func (Methods) Compare

func (methods Methods) Compare(method string) (match bool)

func (Methods) Extend

func (methods Methods) Extend(methods2 Methods) Methods

type Parameters

type Parameters map[string]string

func GetParameters

func GetParameters(c context.Context) Parameters

type Route

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

type RouteBuilder

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

func Delete

func Delete(path string) RouteBuilder

func Filtering

func Filtering(filter Filter) RouteBuilder

func Get

func Get(path string) RouteBuilder

func Method

func Method(methods ...string) RouteBuilder

func NewRouteBuilder

func NewRouteBuilder() RouteBuilder

func Patch

func Patch(path string) RouteBuilder

func Path

func Path(path string) RouteBuilder

func Post

func Post(path string) RouteBuilder

func Put

func Put(path string) RouteBuilder

func (RouteBuilder) Filter

func (builder RouteBuilder) Filter(filter Filter) RouteBuilder

func (RouteBuilder) Method

func (builder RouteBuilder) Method(methods ...string) RouteBuilder

func (RouteBuilder) Path

func (builder RouteBuilder) Path(path string) RouteBuilder

type Router

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

func NewRouter

func NewRouter(configurations ...RoutingConsumer) *Router

func (*Router) Handle

func (r *Router) Handle(routeBuilder RouteBuilder, handler http.Handler)

func (*Router) HandleFunc

func (r *Router) HandleFunc(routeBuilder RouteBuilder, handlerFunc http.HandlerFunc)

func (*Router) Route

func (r *Router) Route(matcher RouteBuilder, configurations ...RoutingConsumer) Routing

func (*Router) ServeHTTP

func (r *Router) ServeHTTP(writer http.ResponseWriter, request *http.Request)

type Routing

type Routing interface {
	HandleFunc(builder RouteBuilder, handlerFunc http.HandlerFunc)
	Handle(builder RouteBuilder, handler http.Handler)
	Route(builder RouteBuilder, configurations ...RoutingConsumer) Routing
}

type RoutingConsumer

type RoutingConsumer func(router Routing)

func DefaultNotFound

func DefaultNotFound() RoutingConsumer

type Segment

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

func (Segment) IsGlobalWildcard

func (seg Segment) IsGlobalWildcard() bool

func (Segment) IsParam

func (seg Segment) IsParam() (is bool, name string)

func (Segment) IsWildcard

func (seg Segment) IsWildcard() bool

func (Segment) Print

func (seg Segment) Print(params map[string]string) string

type Segments

type Segments []Segment

func NewSegments

func NewSegments(template string) (segments Segments)

func (Segments) Compare

func (segments Segments) Compare(path UriPath) (match bool, matched UriPath, params Parameters)

func (Segments) Extend

func (segments Segments) Extend(path Segments) Segments

func (Segments) Print

func (segments Segments) Print(params map[string]string) string

func (Segments) String

func (segments Segments) String() string

type UriPath

type UriPath []string

func NewUriPath

func NewUriPath(path string) UriPath