rewrite

Documentation

Overview

Package rewrite is middleware for rewriting requests internally to a different path.

Index

• type RegexpRule
  • func NewRegexpRule(base, pattern, to string, ext []string) (*RegexpRule, error)
  • func (r *RegexpRule) Rewrite(req *http.Request) bool
• type Rewrite
  • func (rw Rewrite) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type Rule
• type SimpleRule
  • func NewSimpleRule(from, to string) SimpleRule
  • func (s SimpleRule) Rewrite(r *http.Request) bool

Types

type RegexpRule

type RegexpRule struct {
	// Path base. Request to this path and subpaths will be rewritten
	Base string

	// Path to rewrite to
	To string

	// Extensions to filter by
	Exts []string

	*regexp.Regexp
}

RegexpRule is a rewrite rule based on a regular expression

func NewRegexpRule

func NewRegexpRule(base, pattern, to string, ext []string) (*RegexpRule, error)

NewRegexpRule creates a new RegexpRule. It returns an error if regexp pattern (pattern) or extensions (ext) are invalid.

func (*RegexpRule) Rewrite

func (r *RegexpRule) Rewrite(req *http.Request) bool

Rewrite rewrites the internal location of the current request.

type Rewrite

type Rewrite struct {
	Next  middleware.Handler
	Rules []Rule
}

Rewrite is middleware to rewrite request locations internally before being handled.

func (Rewrite) ServeHTTP

func (rw Rewrite) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP implements the middleware.Handler interface.

type Rule

type Rule interface {
	// Rewrite rewrites the internal location of the current request.
	Rewrite(*http.Request) bool
}

Rule describes an internal location rewrite rule.

type SimpleRule

type SimpleRule struct {
	From, To string
}

SimpleRule is a simple rewrite rule.

func NewSimpleRule

func NewSimpleRule(from, to string) SimpleRule

NewSimpleRule creates a new Simple Rule

func (SimpleRule) Rewrite

func (s SimpleRule) Rewrite(r *http.Request) bool

Rewrite rewrites the internal location of the current request.