Documentation
¶
Overview ¶
Package route matches HTTP requests against net/http.ServeMux patterns.
Index ¶
- func Wildcards(pattern string) []string
- type Map
- type Matcher
- func (m *Matcher) Declare(declaration protocol.Declaration) error
- func (m *Matcher) Request(requestMethod, requestHost, requestPath string) (request Request, wildcards map[string]string, matched bool)
- func (m *Matcher) Requests() []Request
- func (m *Matcher) Responses(requestMethod, requestPath string, header http.Header) (rules []javascript.Rule, ignored Option[string])
- type Pattern
- type Request
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Map ¶
type Map[T any] struct { // contains filtered or unexported fields }
Map assigns a value to each pattern. Build it with Add before sharing it; concurrent Match calls are safe once construction is complete.
func (*Map[T]) Add ¶
Add assigns a value to a "<METHOD> [<host>]/<path>" pattern, which must name an HTTP method. A pattern without a host matches every host.
func (*Map[T]) Match ¶
func (m *Map[T]) Match(requestMethod, requestHost, requestPath string) (value T, wildcards map[string]string, matched bool)
Match returns a request's value and wildcards; requestPath must be escaped. Unlike ServeMux, a GET pattern does not match HEAD, whose empty responses need their own pattern.
type Matcher ¶
type Matcher struct {
// contains filtered or unexported fields
}
Matcher holds the HTTP endpoints and rules that scripts declare. The engine declares every one before serving starts; matching is then safe for concurrent use.
func (*Matcher) Declare ¶
func (m *Matcher) Declare(declaration protocol.Declaration) error
Declare adds an endpoint or a rule. Egress request patterns name a host; ingress rule patterns do not.
func (*Matcher) Request ¶
func (m *Matcher) Request(requestMethod, requestHost, requestPath string) (request Request, wildcards map[string]string, matched bool)
Request returns the endpoint a dependency request matches and its path wildcards. requestPath must be escaped.
func (*Matcher) Responses ¶ added in v0.43.0
func (m *Matcher) Responses(requestMethod, requestPath string, header http.Header) (rules []javascript.Rule, ignored Option[string])
Responses returns, in order, the rules that may select an inbound request's responses, or why every response is ignored. requestPath must be escaped.
type Pattern ¶ added in v0.43.0
type Pattern struct {
// contains filtered or unexported fields
}
Pattern is one "[<METHOD> ][<host>]/<path>" pattern. Without a method it matches every method; otherwise, as in Map, a GET pattern does not match HEAD.
func NewPattern ¶ added in v0.43.0
NewPattern checks a pattern and returns a matcher for it.
Source Files