package uritemplate

Import Path
	github.com/yosida95/uritemplate/v3 (on go.dev)

Dependency Relation
	imports 9 packages, and imported by one package

Involved Source Files

	    compile.go
	    equals.go
	    error.go
	    escape.go
	    expression.go
	    machine.go
	    match.go
	    parse.go
	    prog.go
	    uritemplate.go
	    value.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type CompareFlags uint8 (basic type)

		As Inputs Of (at least one exported)
			func Equals(t1 *Template, t2 *Template, flags CompareFlags) bool
		As Types Of (only one)
			const CompareVarname

	 type Template (struct)
		Template represents a URI Template.

		Methods (total 5)
			(*Template) Expand(vars Values) (string, error)
				Expand returns a URI reference corresponding to the template expanded using the passed variables.

			(*Template) Match(expansion string) Values
			(*Template) Raw() string
				Raw returns a raw URI template passed to New in string.

			(*Template) Regexp() *regexp.Regexp
				Regexp converts the template to regexp and returns compiled *regexp.Regexp.

			(*Template) Varnames() []string
				Varnames returns variable names used in the template.

		As Outputs Of (at least 2)
			func MustNew(template string) *Template
			func New(template string) (*Template, error)
		As Inputs Of (at least 2)
			func Equals(t1 *Template, t2 *Template, flags CompareFlags) bool
			func Equals(t1 *Template, t2 *Template, flags CompareFlags) bool

	 type Value (struct)

		Fields (total 2)
			T ValueType
			V []string
		Methods (total 4)
			( Value) KV() []string
			( Value) List() []string
			( Value) String() string
			( Value) Valid() bool
		Implements (at least 2)
			 Value : expvar.Var
			 Value : fmt.Stringer
		As Outputs Of (at least 4)
			func KV(kv ...string) Value
			func List(v ...string) Value
			func String(v string) Value
			func Values.Get(name string) Value
		As Inputs Of (at least one exported)
			func Values.Set(name string, value Value)

	 type Values (map)
		A varname containing pct-encoded characters is not the same variable as
		a varname with those same characters decoded.
		
		-- https://tools.ietf.org/html/rfc6570#section-2.3

		Methods (total 2)
			( Values) Get(name string) Value
			( Values) Set(name string, value Value)
		As Outputs Of (at least one exported)
			func (*Template).Match(expansion string) Values
		As Inputs Of (at least one exported)
			func (*Template).Expand(vars Values) (string, error)

	 type ValueType uint8 (basic type)

		Methods (only one)
			( ValueType) String() string
		Implements (at least 2)
			 ValueType : expvar.Var
			 ValueType : fmt.Stringer


Package-Level Functions (total 6)

	 func Equals(t1 *Template, t2 *Template, flags CompareFlags) bool
		Equals reports whether or not two URI Templates t1 and t2 are equivalent.

	 func KV(kv ...string) Value
		KV returns Value that represents associative list.
		KV panics if len(kv) is not even.

	 func List(v ...string) Value
		List returns Value that represents list.

	 func MustNew(template string) *Template
		MustNew panics if the template cannot be recognized.

	 func New(template string) (*Template, error)
		New parses and constructs a new Template instance based on the template.
		New returns an error if the template cannot be recognized.

	 func String(v string) Value
		String returns Value that represents string.


Package-Level Constants (total 4)

	const CompareVarname CompareFlags = 1
	const ValueTypeKV = 2
	const ValueTypeList = 1
	const ValueTypeString = 0

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.