argv

Documentation

Index

• Constants
• func Middleware(next http.Handler) (this http.Handler)
• type Argv
  • func DecodeHttpRequest(r *http.Request) (reqArgv *Argv)
  • func DecomposeHttpRequest(r *http.Request) (reqArgv *Argv)
  • func Get(r *http.Request) (reqArgv *Argv)
  • func ProcessRequest(r *http.Request) (argv *Argv, modified *http.Request)
  • func (ra *Argv) Copy() (reqArg *Argv)
  • func (ra *Argv) MustConsume() (must bool)
  • func (ra *Argv) Set(r *http.Request) (req *http.Request)
  • func (ra *Argv) String() (argvUrl string)
• type Pagination

Constants

const (
	RequestKey         request.Key = "RequestArgv"
	RequestRedirectKey string      = "RequestRedirect"
	RequestIgnoredKey  string      = "RequestArgvIgnored"
	RequestConsumedKey string      = "RequestArgvConsumed"
)

const (
	RouteOneArg  = `:{arg0:[^/]+}`
	RouteTwoArgs = `:{arg0:[^/]+}/:{arg1:[^/]+}`
	RoutePgntn   = `{num-per-page:\d+}/{page-number:\d+}`
)

Functions

func Middleware

func Middleware(next http.Handler) (this http.Handler)

Types

type Argv

type Argv struct {
	Path       string
	Argv       [][]string
	NumPerPage int
	PageNumber int
	Language   language.Tag
	Request    *http.Request
}

func DecodeHttpRequest

func DecodeHttpRequest(r *http.Request) (reqArgv *Argv)

func DecomposeHttpRequest

func DecomposeHttpRequest(r *http.Request) (reqArgv *Argv)

func Get

func Get(r *http.Request) (reqArgv *Argv)

func ProcessRequest

func ProcessRequest(r *http.Request) (argv *Argv, modified *http.Request)

func (*Argv) Copy

func (ra *Argv) Copy() (reqArg *Argv)

func (*Argv) MustConsume

func (ra *Argv) MustConsume() (must bool)

func (*Argv) Set

func (ra *Argv) Set(r *http.Request) (req *http.Request)

func (*Argv) String

func (ra *Argv) String() (argvUrl string)

type Pagination

type Pagination struct {
	// BasePath is the URL path to use when generating pagination links
	BasePath string `json:"BasePath"`
	// PageNumber is the current page number in human format (lists start at 1)
	PageNumber int `json:"PageNumber"`
	// NumPerPage is the number of results per page requested
	NumPerPage int `json:"NumPerPage"`
	// PageIndex is the current page number in computer format (lists start at 0)
	PageIndex int `json:"PageIndex"`
	// LastIndex is the last page number in computer format
	LastIndex int `json:"LastIndex"`
	// TotalItems is the total number of items available
	TotalItems int `json:"TotalItems"`
	// TotalPages is the total number of pagination pages available
	TotalPages int `json:"TotalPages"`
	// StartItem is the number of the first item being presented
	StartItem int `json:"StartItem"`
	// EndItem is the number of the last item being presented
	EndItem int `json:"EndItem"`
	// SearchQuery is an optional plain text string to be included with generated output
	SearchQuery string `json:"SearchQuery"`
}