trietree

Documentation

Index

• type Node
  • func (n *Node[T]) Get(path string) (data T, params Params, tsr *Node[T])
  • func (n *Node[T]) Set(path string, data T)
• type Param
• type Params
  • func (ps Params) ByName(name string) string

Types

type Node

type Node[T any] struct {
	// contains filtered or unexported fields
}

func (*Node[T]) Get

func (n *Node[T]) Get(path string) (data T, params Params, tsr *Node[T])

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.

func (*Node[T]) Set

func (n *Node[T]) Set(path string, data T)

Set adds a Node with the given handle to the path. Not concurrency-safe!

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.