sifis-home / datta

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

datta

datta 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.

It is a fork of rust-uritemplate.

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.

Acknowledgements

This software has been developed in the scope of the H2020 project SIFIS-Home with GA n. 952652.

datta's Issues

Fix LICENSE file

GitHub is not able to recognize the LICENSE file. Probably there is something wrong with that, we should fix it using the actual BSD-3-Clause template.

Fix doctests

There are some ignored tests which does not pass if cargo test -- --ignored is run.

This can be pretty annoying, because code from docs is expected to run and pass.

Thin the current CI

The crate does not have os-specific codepaths so might be better to turn off macos and windows and move the extended check in the linux CI.

Move Miri check to a manual action

Miri takes a huge amount of time to run in CI. We are not using any unsafe code (we could also add a deny(unsafe) pragma @lu-zero), therefore it makes sense to keep it separated from the normal workflow.

It could be included in the pre-tag actions, just to have some stricter checks before publication.