Struct ParameterizedRoute

pub struct ParameterizedRoute { /* private fields */ }

Defines a route structure that can be used to define routes for a webserver.

Its templated sections can be easily populated to create a WebRoute which can be used to make requests against the webserver routes that the ParameterizedRoute was used to define.

Implementations

impl ParameterizedRoute

pub fn new<R: ToParameterizedSegments>(route: R) -> Self

Creates a new ParameterizedRoute.

Examples

use web_route::ParameterizedRoute;

let route = ParameterizedRoute::new("/some/route/{param}");

pub fn join<R: ToParameterizedSegments>(&self, route: R) -> Self

Joins a route onto an existing ParameterizedRoute returning the joined route.

Examples

use web_route::ParameterizedRoute;

let route = ParameterizedRoute::new("/some/route/{param}");
let nested_route = ParameterizedRoute::new("/a/nested/route");
let joined_route = route.join(&nested_route);

assert_eq!(joined_route, route.join("/a/nested/route"))

pub fn to_web_route<V: Serialize>( &self, values: &V, ) -> Result<WebRoute, WebRouteError>

Attempts to populate the parameters of the route with their values and returns a WebRoute.

values needs to implement serde::Serialize and be of an “Object” style (with key-value pairs).

This would be used when making a request to an endpoint represented by the route.

Errors

• WebRouteError::UnpopulatedParam if no matching entry was found in values for a particular parameter.
• WebRouteError::InvalidValue if values does not contain key-value pairs.

Examples

use web_route::ParameterizedRoute;

#[derive(serde::Serialize)]
struct RouteParams {
    param: String,
}

let parameterized_route = ParameterizedRoute::new("/some/route/{param}");
let web_route = parameterized_route
    .to_web_route(&RouteParams {
        param: "value".to_owned(),
    })
    .unwrap();
     
assert_eq!(&web_route.to_string(), "/some/route/value")

Trait Implementations

impl Clone for ParameterizedRoute

fn clone(&self) -> ParameterizedRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParameterizedRoute

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

Formats the value using the given formatter.

impl Display for ParameterizedRoute

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

Formats the value using the given formatter.

impl PartialEq for ParameterizedRoute

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ParameterizedRoute