routes

Documentation

Overview

Package routes is used for parsing route comments and route field tags.

Index

• type Prefixes
  • func NewPrefixes() Prefixes
  • func ParseTag(t string) (ps Prefixes)
  • func (ps Prefixes) ParseRoutes(controller string, f *r.Func) (rs []Route)
• type Route

Types

type Prefixes

type Prefixes []Route

Prefixes stores information about route prefixes of a controller.

func NewPrefixes

func NewPrefixes() Prefixes

NewPrefixes allocates and returns a new Prefixes object.

func ParseTag

func ParseTag(t string) (ps Prefixes)

ParseTag gets a tag string and extracts route prefixes out of it. If that's not possible, {}, false is returned.

func (Prefixes) ParseRoutes

func (ps Prefixes) ParseRoutes(controller string, f *r.Func) (rs []Route)

ParseRoutes gets a controller name and an action function and returns all the routes that are presented in its comments concatenated with the specified prefixes. If method is specified however pattern isn't, controller/action combination is used as a pattern.

type Route

type Route struct {
	Pattern, Method, HandlerName, Label string
}

Route represents a single route, i.e. pattern and an associated method.