#template #uri #url #rfc6570 #uritemplates

uritemplate-next

Rust implementation of RFC6570 - URI Template that can processURI Templates up and to including ones designated Level 4

1 unstable release

0.2.0 Nov 21, 2020

#322 in Template engine

Download history 154774/week @ 2024-11-16 93449/week @ 2024-11-23 87666/week @ 2024-11-30 184902/week @ 2024-12-07 145193/week @ 2024-12-14 43414/week @ 2024-12-21 74256/week @ 2024-12-28 148890/week @ 2025-01-04 141727/week @ 2025-01-11 117132/week @ 2025-01-18 147059/week @ 2025-01-25 156763/week @ 2025-02-01 164416/week @ 2025-02-08 163902/week @ 2025-02-15 196696/week @ 2025-02-22 158689/week @ 2025-03-01

712,399 downloads per month
Used in 41 crates (4 directly)

BSD-3-Clause

32KB
551 lines

rust-uritemplate

Build Status Cargo version License

Documentation

rust-uritemplate is a Rust implementation of RFC6570 - URI Template that can process URI Templates up to and including ones designated as Level 4 by the specification. It passes all of the tests in the uritemplate-test test suite.

Basic Usage

Variable setting can be chained for nice, clean code.

let uri = UriTemplate::new("/view/{object:1}/{/object,names}{?query*}")
    .set("object", "lakes")
    .set("names", &["Erie", "Superior", "Ontario"])
    .set("query", &[("size", "15"), ("lang", "en")])
    .build();

assert_eq!(uri, "/view/l/lakes/Erie,Superior,Ontario?size=15&lang=en");

It is not possible to set a variable to the value "undefined". Instead, simply delete the variable if you have already set it.

let mut t = UriTemplate::new("{hello}");
t.set("hello", "Hello World!");
assert_eq!(t.build(), "Hello%20World%21");

t.delete("hello");
assert_eq!(t.build(), "");

The delete function returns true if the variable existed and false otherwise.

Supported Types

Any type that implements IntoTemplateVar can be set as the value of a UriTemplate variable. The following implementations are provided by default for each type of variable:

  • Scalar Values: String, &str
  • Lists: Vec<String>, &[String], &[str]
  • Associative Arrays: Vec<(String, String)>, &[(String, String)], &[(&str, &str)], &HashMap<String, String>

In addition, you can implement IntoTemplateVar for your own types. View the documentation for IntoTemplateVar for information on how that works.

Dependencies

~2–3MB
~53K SLoC