The highest tagged major version is
README
¶
uritemplate =========== `uritemplate`_ is a Go implementation of `URI Template`_ [RFC6570] with full functionality of URI Template Level 4. uritemplate can also generate a regexp that matches expansion of the URI Template from a URI Template. Getting Started --------------- Installation ~~~~~~~~~~~~ .. code-block:: sh $ go get -u github.com/yosida95/uritemplate Documentation ~~~~~~~~~~~~~ The documentation is available on GoDoc_. Examples -------- See `examples on GoDoc`_. License ------- `uritemplate`_ is distributed under the BSD 3-Clause license. PLEASE READ ./LICENSE carefully and follow its clauses to use this software. Author ------ yosida95_ .. _`URI Template`: https://tools.ietf.org/html/rfc6570 .. _Godoc: https://godoc.org/github.com/yosida95/uritemplate .. _`examples on GoDoc`: https://godoc.org/github.com/yosida95/uritemplate#pkg-examples .. _yosida95: https://yosida95.com/ .. _uritemplate: https://github.com/yosida95/uritemplate
Documentation
¶
Index ¶
Examples ¶
Constants ¶
View Source
const ( ValueTypeString = iota ValueTypeList ValueTypeKV )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Template ¶
type Template struct {
// contains filtered or unexported fields
}
Template represents a URI Template.
func New ¶
New parses and constructs a new Template instance based on the template. New returns an error if the template cannot be recognized.
func (*Template) Expand ¶
Expand returns a URI reference corresponding to the template expanded using the passed variables.
Example ¶
tmpl := MustNew("https://example.com/dictionary/{term:1}/{term}")
vars := Values{}
vars.Set("term", String("cat"))
ret, err := tmpl.Expand(vars)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(ret)
Output: https://example.com/dictionary/c/cat
func (*Template) Match ¶
Example ¶
tmpl := MustNew("https://example.com/dictionary/{term:1}/{term}")
match := tmpl.Match("https://example.com/dictionary/c/cat")
if match == nil {
fmt.Println("not matched")
return
}
fmt.Printf("term:1 is %q\n", match.Get("term:1").String())
fmt.Printf("term is %q\n", match.Get("term").String())
Output: term:1 is "c" term is "cat"
func (*Template) Regexp ¶
Regexp converts the template to regexp and returns compiled *regexp.Regexp.
Example ¶
tmpl := MustNew("https://example.com/dictionary/{term:1}/{term}")
re := tmpl.Regexp()
fmt.Println(re.MatchString("https://example.com/dictionary/c/cat"))
fmt.Println(re.MatchString("https://example.com/dictionary/c/a/cat"))
Output: true false
Source Files
Click to show internal directories.
Click to hide internal directories.