Struct routerify::RouteParams [−][src]
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
[src]
pub fn new() -> RouteParams
[src]
Creates an empty route parameters map.
pub fn with_capacity(capacity: usize) -> RouteParams
[src]
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
)
[src]
&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>
[src]
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
[src]
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
[src]
Returns the length of the route parameters.
pub fn params_names(&self) -> impl Iterator<Item = &String>
[src]
Returns an Iterator
over the parameter names.
pub fn iter(&self) -> impl Iterator<Item = (&String, &String)>
[src]
Returns an Iterator
over the parameter entries
as (parameter_name: &String, parameter_value: &String)
.
pub fn extend(&mut self, other_route_params: RouteParams)
[src]
Extends the current parameters map with other one.
Trait Implementations
impl Clone for RouteParams
[src]
fn clone(&self) -> RouteParams
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for RouteParams
[src]
Auto Trait Implementations
impl RefUnwindSafe for RouteParams
impl Send for RouteParams
impl Sync for RouteParams
impl Unpin for RouteParams
impl UnwindSafe for RouteParams
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,