runtime

Documentation

Index

• Variables
• type Matcher
  • func Compile(path string) (Matcher, error)
• type Pattern
  • func MustPattern(p Pattern, err error) Pattern
  • func NewPattern(version int, ops []int, pool []string, verb string) (Pattern, error)
  • func (p Pattern) Match(components []string, verb string) (map[string]string, error)
  • func (p Pattern) String() string
  • func (p Pattern) Verb() string

Variables

var (
	// ErrNotMatch indicates that the given HTTP request path does not match to the pattern.
	ErrNotMatch = errors.New("not match to the path pattern")
	// ErrInvalidPattern indicates that the given definition of Pattern is not valid.
	ErrInvalidPattern = errors.New("invalid pattern")
)

Types

type Matcher

type Matcher interface {
	Match(path string) (map[string]string, error)
	IsStatic() bool
	Fields() []string
	Pattern() string
}

Matcher .

func Compile

func Compile(path string) (Matcher, error)

Compile .

type Pattern

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

Pattern is a template pattern of http request paths defined in https://github.com/googleapis/googleapis/blob/master/google/api/http.proto

func MustPattern

func MustPattern(p Pattern, err error) Pattern

MustPattern is a helper function which makes it easier to call NewPattern in variable initialization.

func NewPattern

func NewPattern(version int, ops []int, pool []string, verb string) (Pattern, error)

NewPattern returns a new Pattern from the given definition values. "ops" is a sequence of op codes. "pool" is a constant pool. "verb" is the verb part of the pattern. It is empty if the pattern does not have the part. "version" must be 1 for now. It returns an error if the given definition is invalid.

func (Pattern) Match

func (p Pattern) Match(components []string, verb string) (map[string]string, error)

Match examines components if it matches to the Pattern. If it matches, the function returns a mapping from field paths to their captured values. If otherwise, the function returns an error.

func (Pattern) String

func (p Pattern) String() string

func (Pattern) Verb

func (p Pattern) Verb() string

Verb returns the verb part of the Pattern.