redirect

Documentation

Overview

Package redirect provides compiling and matching redirect and rewrite rules.

Index

• type Matcher
  • func Compile(rules Rules) (*Matcher, error)
  • func (m *Matcher) Lookup(path string) *Rule
• type Rule
  • func (r *Rule) Compile()
  • func (r *Rule) IsDynamic() bool
  • func (r *Rule) IsRewrite() bool
  • func (r Rule) URL(path string) string
• type Rules

Types

type Matcher

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

Matcher for header lookup.

func Compile

func Compile(rules Rules) (*Matcher, error)

Compile the given rules to a trie.

func (*Matcher) Lookup

func (m *Matcher) Lookup(path string) *Rule

Lookup returns fields for the given path.

type Rule

type Rule struct {
	Path     string `json:"path"`
	Location string `json:"location"`
	Status   int    `json:"status"`
	Force    bool   `json:"force"`
	// contains filtered or unexported fields
}

Rule is a single redirect rule.

func (*Rule) Compile

func (r *Rule) Compile()

Compile the rule.

func (*Rule) IsDynamic

func (r *Rule) IsDynamic() bool

IsDynamic returns true if a splat or placeholder is used.

func (*Rule) IsRewrite

func (r *Rule) IsRewrite() bool

IsRewrite returns true if the rule represents a rewrite.

func (Rule) URL

func (r Rule) URL(path string) string

URL returns the final destination after substitutions from path.

type Rules

type Rules map[string]Rule

Rules map of paths to redirects.