Struct rfc6570_level_2::UriTemplate

pub struct UriTemplate(_);

A template URI validated against RFC6570 Level 2.

Implementations

impl UriTemplate

pub fn new(uri: &str) -> Result<Self>

Validates a string against RFC6570 Level 2; if valid, returns a URI template that can later be expanded.

Examples

use rfc6570_level_2::UriTemplate;

let template = UriTemplate::new("https://example.com/{resource}/{+id}{#field}")?;
assert_eq!(template.uri(), "https://example.com/{resource}/{+id}{#field}");

Errors

An error describing the offending component will be returned in case of a validation failure.

#[must_use]pub fn uri(&self) -> &str

Returns a reference to the string backing the URI template.

Examples

use rfc6570_level_2::UriTemplate;

let template = UriTemplate::new("https://example.com/{resource}/{+id}{#field}")?;
assert_eq!(template.uri(), "https://example.com/{resource}/{+id}{#field}");

pub fn expressions(&self) -> impl Iterator<Item = &str>

Returns an iterator over the expressions contained within the URI template.

Examples

use rfc6570_level_2::UriTemplate;

let template = UriTemplate::new("https://example.com/{resource}/{+id}{#field}")?;
let expressions: Vec<&str> = template.expressions().collect();
assert_eq!(expressions, vec!["{resource}", "{+id}", "{#field}"]);

pub fn variables(&self) -> impl Iterator<Item = &str>

Returns an iterator over the variable definitions contained within the URI template.

Examples

use rfc6570_level_2::UriTemplate;

let template = UriTemplate::new("https://example.com/{resource}/{+id}{#field}")?;
let variables: Vec<&str> = template.variables().collect();
assert_eq!(variables, vec!["resource", "id", "field"]);

#[must_use]pub fn expand(&self, variables: &HashMap<&str, &str>) -> String

Returns a copy of the URI template string, with all expressions expanded based on the given variable map.

Examples

use rfc6570_level_2::UriTemplate;
use std::collections::HashMap;

let template = UriTemplate::new("https://example.com/{resource}/{+id}{#field}")?;
let var_map = [
    ("resource", "user"),
    ("id", "5"),
    ("field", "email"),
].iter().cloned().collect();
let uri = template.expand(&var_map);
assert_eq!(uri, "https://example.com/user/5#email");

Trait Implementations

impl Clone for UriTemplate

pub fn clone(&self) -> UriTemplate

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UriTemplate

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

Formats the value using the given formatter.

impl Eq for UriTemplate

impl Hash for UriTemplate

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for UriTemplate

pub fn cmp(&self, other: &UriTemplate) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<UriTemplate> for UriTemplate

pub fn eq(&self, other: &UriTemplate) -> bool

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

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

This method tests for !=.

impl PartialOrd<UriTemplate> for UriTemplate

pub fn partial_cmp(&self, other: &UriTemplate) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &UriTemplate) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &UriTemplate) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &UriTemplate) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &UriTemplate) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for UriTemplate

impl StructuralPartialEq for UriTemplate