Struct hyperbole::tree::PathSpec

#[repr(C)]pub struct PathSpec<P> { /* fields omitted */ }

A uri specification and well-typed parameter parser.

See the path! macro for usage details.

Implementations

impl PathSpec<HNil>

pub const ROOT: Self

The root path.

impl<P> PathSpec<P>

pub fn segment(self, name: &'static str) -> Self

Append a static segment to this spec.

Panics

This panics if the segment contains /, or if the path spec already contains a catch-all parameter.

pub fn dynamic<T: FromStr>(
    self,
    name: &'static str
) -> PathSpec<<P as Add<HCons<T, HNil>>>::Output> where
    P: Add<HCons<T, HNil>>, 

Append a dynamic path parameter of type T to this spec.

Panics

This panics if the path spec already contains a catch-all parameter.

pub fn catch_all<T: FromStr>(
    self,
    name: &'static str
) -> PathSpec<<P as Add<HCons<T, HNil>>>::Output> where
    P: Add<HCons<T, HNil>>, 

Append a catch-all path parameter of type T to this spec.

Panics

This panics if the path spec already contains a catch-all parameter.

pub fn query<T: FromStr>(
    self,
    name: &'static str
) -> PathSpec<<P as Add<HCons<T, HNil>>>::Output> where
    P: Add<HCons<T, HNil>>, 

Add a query parameter of type T to this spec.

Panics

This panics if the path spec already contains a query parameter with the same name.

Trait Implementations

impl<P> Clone for PathSpec<P>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Display for PathSpec<P>

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

use hyperbole::path;
use std::fmt::Display;

fn eq<D: Display>(a: &str, b: D) {
    assert_eq!(a, format!("{}", b));
}

eq("/", path![]);
eq("/", path![? p1: u8]);
eq("/one/:two/three", path!["one" / two: u32 / "three"]);
eq("/one/:two/three", path!["one" / two: u32 / "three" ? p1: u8]);
eq("/one/:two/*three", path!["one" / two: u32 / *three: String]);
eq("/one/:two/*three", path!["one" / two: u32 / *three: String ? p1: u8]);