Struct routerify::RouteParams

pub struct RouteParams(_);

Represents a map of the route parameters using the name of the parameter specified in the path as their respective keys.

Please refer to the Route Parameters section for more info.

Note: This type shouldn’t be created directly. It will be populated into the req object of the route handler and can be accessed as req.params().

Implementations

impl RouteParams

pub fn new() -> RouteParams

Creates an empty route parameters map.

pub fn with_capacity(capacity: usize) -> RouteParams

Creates an empty route parameters map with the specified capacity.

pub fn set<N: Into<String>, V: Into<String>>(
    &mut self,
    param_name: N,
    param_val: V
)

Sets a new parameter entry with the specified key and the value.

pub fn get<N: Into<String>>(&self, param_name: N) -> Option<&String>

Returns the route parameter value mapped with the specified key.

Examples

use routerify::{Router, RouteParams};
use routerify::ext::RequestExt;
use hyper::{Response, Body};

let router = Router::builder()
    .get("/users/:userName/books/:bookName", |req| async move {
        let params: &RouteParams = req.params();
         
        let user_name = params.get("userName").unwrap();
        let book_name = params.get("bookName").unwrap();

        Ok(Response::new(Body::from(format!("Username: {}, Book Name: {}", user_name, book_name))))
     })
     .build()
     .unwrap();

pub fn has<N: Into<String>>(&self, param_name: N) -> bool

Checks if a route parameter exists.

Examples

use routerify::{Router, RouteParams};
use routerify::ext::RequestExt;
use hyper::{Response, Body};

let router = Router::builder()
    .get("/users/:userName", |req| async move {
        let params: &RouteParams = req.params();
         
        if params.has("userName") {
            Ok(Response::new(Body::from(params.get("userName").unwrap().to_string())))
        } else {
            Ok(Response::new(Body::from("username is not provided")))
        }
     })
     .build()
     .unwrap();

pub fn len(&self) -> usize

Returns the length of the route parameters.

pub fn is_empty(&self) -> bool

pub fn params_names(&self) -> impl Iterator<Item = &String>

Returns an Iterator over the parameter names.

pub fn iter(&self) -> impl Iterator<Item = (&String, &String)>

Returns an Iterator over the parameter entries as (parameter_name: &String, parameter_value: &String).

pub fn extend(&mut self, other_route_params: RouteParams)

Extends the current parameters map with other one.

Trait Implementations

impl Clone for RouteParams

fn clone(&self) -> RouteParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteParams

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

Formats the value using the given formatter.

impl Default for RouteParams

fn default() -> RouteParams

Returns the “default value” for a type.