tree

Documentation

Index

• func CleanPath(p string) string
• type Node
  • func (n *Node) AddRoute(path string, handle xrest.Handler)
  • func (n *Node) FindCaseInsensitivePath(path string, fixTrailingSlash bool) (ciPath []byte, found bool)
  • func (n *Node) GetValue(path string) (handle xrest.Handler, p Params, tsr bool)
• type Param
• type Params
  • func (ps Params) ByName(name string) string

Functions

func CleanPath

func CleanPath(p string) string

CleanPath is the URL version of path.Clean, it returns a canonical URL path for p, eliminating . and .. elements.

The following rules are applied iteratively until no further processing can be done:

1. Replace multiple slashes with a single slash.
2. Eliminate each . path name element (the current directory).
3. Eliminate each inner .. path name element (the parent directory) along with the non-.. element that precedes it.
4. Eliminate .. elements that begin a rooted path: that is, replace "/.." by "/" at the beginning of a path.

If the result of this process is an empty string, "/" is returned

Types

type Node

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

func (*Node) AddRoute

func (n *Node) AddRoute(path string, handle xrest.Handler)

AddRoute adds a node with the given handle to the path. Not concurrency-safe!

func (*Node) FindCaseInsensitivePath

func (n *Node) FindCaseInsensitivePath(path string, fixTrailingSlash bool) (ciPath []byte, found bool)

Makes a case-insensitive lookup of the given path and tries to find a handler. It can optionally also fix trailing slashes. It returns the case-corrected path and a bool indicating whether the lookup was successful.

func (*Node) GetValue

func (n *Node) GetValue(path string) (handle xrest.Handler, p Params, tsr bool)

GetValue Returns the handle registered with the given path (key). The values of wildcards are saved to a map. If no handle can be found, a TSR (trailing slash redirect) recommendation is made if a handle exists with an extra (without the) trailing slash for the given path.

type Param

type Param struct {
	Key   string
	Value string
}

Param is a single URL parameter, consisting of a key and a value.

type Params

type Params []Param

Params is a Param-slice, as returned by the router. The slice is ordered, the first URL parameter is also the first slice value. It is therefore safe to read values by the index.

func (Params) ByName

func (ps Params) ByName(name string) string

ByName returns the value of the first Param which key matches the given name. If no matching Param is found, an empty string is returned.