Struct WebRoute

pub struct WebRoute { /* private fields */ }

Implementations

impl WebRoute

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

Creates a new WebRoute.

Examples

use web_route::WebRoute;

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

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

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

Examples

use web_route::WebRoute;

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

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

pub fn as_template_route(&self) -> String

Returns the route in its “templated” representation so that it can be used in web server route definitions.

Examples

use web_route::WebRoute;

let route = WebRoute::new("/some/route/{param}");
let template_route = route.as_template_route();

assert_eq!(template_route, "/some/route/{param}")

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

Attempts to populate the parameters of the route with their values.

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::WebRoute;

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

let route = WebRoute::new("/some/route/{param}");
let populated_route = route
    .as_populated_route(&RouteParams {
        param: "value".to_owned(),
    })
    .unwrap();
     
assert_eq!(populated_route, "/some/route/value")

Trait Implementations

impl Clone for WebRoute

fn clone(&self) -> WebRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebRoute

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebRoute

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebRoute

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

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

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 Serialize for WebRoute

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WebRoute