Struct uri_template_system_core::Template

pub struct Template<'t> { /* private fields */ }

The Template type is the basis for most simple tasks. Parsing and expansion are both template functions.

Implementations

impl<'t> Template<'t>

pub const fn expand<'e>(&'e self, values: &'e Values) -> Expansion<'e, 't>

Creates a new Expansion using the given Values, which may then be rendered using the to_string function provided by the Display trait.

let template = Template::parse("hello/{name}!").unwrap();
let values = Values::default().add("name", Value::item("world"));

assert_eq!("hello/world!", template.expand(&values).to_string());

pub fn parse(raw: &'t str) -> Result<Self, ParseError>

Parses a string representing a potential template, and returns a new template instance if valid. See https://datatracker.ietf.org/doc/html/rfc6570 for the grammar of a valid URI Template. uri-template-system supports all operators and modifiers up-to and including Level 4.

let template = Template::parse("my/valid/{template}");

assert!(template.is_ok());

Trait Implementations

impl<'t> Debug for Template<'t>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'t> PartialEq<Template<'t>> for Template<'t>

fn eq(&self, other: &Template<'t>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'t> Eq for Template<'t>

impl<'t> StructuralEq for Template<'t>

impl<'t> StructuralPartialEq for Template<'t>