1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
mod de;
use std::ops::{Deref, DerefMut};
pub(crate) use de::PathDeserializer;
use serde::de::DeserializeOwned;
use crate::{error::ParsePathError, FromRequest, Request, RequestBody, Result};
/// An extractor that will get captures from the URL and parse them using
/// `serde`.
///
/// # Errors
///
/// - [`ParsePathError`]
///
/// # Example
///
/// ```
/// use poem::{
/// get, handler,
/// http::{StatusCode, Uri},
/// web::Path,
/// Endpoint, Request, Route,
/// };
///
/// #[handler]
/// async fn users_teams_show(Path((user_id, team_id)): Path<(String, String)>) -> String {
/// format!("{}:{}", user_id, team_id)
/// }
///
/// let app = Route::new().at("/users/:user_id/team/:team_id", get(users_teams_show));
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = app
/// .call(
/// Request::builder()
/// .uri(Uri::from_static("/users/100/team/300"))
/// .finish(),
/// )
/// .await
/// .unwrap();
/// assert_eq!(resp.status(), StatusCode::OK);
/// assert_eq!(resp.into_body().into_string().await.unwrap(), "100:300");
/// # });
/// ```
///
/// If the path contains only one parameter, then you can omit the tuple.
///
/// ```
/// use poem::{
/// get, handler,
/// http::{StatusCode, Uri},
/// web::Path,
/// Endpoint, Request, Route,
/// };
///
/// #[handler]
/// async fn user_info(Path(user_id): Path<String>) -> String {
/// user_id
/// }
///
/// let app = Route::new().at("/users/:user_id", get(user_info));
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = app
/// .call(
/// Request::builder()
/// .uri(Uri::from_static("/users/100"))
/// .finish(),
/// )
/// .await
/// .unwrap();
/// assert_eq!(resp.status(), StatusCode::OK);
/// assert_eq!(resp.into_body().into_string().await.unwrap(), "100");
/// # });
/// ```
///
/// Path segments also can be deserialized into any type that implements [`serde::Deserialize`](https://docs.rs/serde/1.0.127/serde/trait.Deserialize.html).
/// Path segment labels will be matched with struct field names.
///
/// ```
/// use poem::{
/// get, handler,
/// http::{StatusCode, Uri},
/// web::Path,
/// Endpoint, Request, Route,
/// };
/// use serde::Deserialize;
///
/// #[derive(Deserialize)]
/// struct Params {
/// user_id: String,
/// team_id: String,
/// }
///
/// #[handler]
/// async fn users_teams_show(Path(Params { user_id, team_id }): Path<Params>) -> String {
/// format!("{}:{}", user_id, team_id)
/// }
///
/// let app = Route::new().at("/users/:user_id/team/:team_id", get(users_teams_show));
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = app
/// .call(
/// Request::builder()
/// .uri(Uri::from_static("/users/foo/team/100"))
/// .finish(),
/// )
/// .await
/// .unwrap();
/// assert_eq!(resp.status(), StatusCode::OK);
/// assert_eq!(resp.into_body().into_string().await.unwrap(), "foo:100");
/// # });
/// ```
#[derive(Debug, Eq, PartialEq, Clone)]
pub struct Path<T>(pub T);
impl<T> Deref for Path<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl<T> DerefMut for Path<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl<T: DeserializeOwned> Path<T> {
async fn internal_from_request(req: &Request) -> Result<Self, ParsePathError> {
Ok(Path(
T::deserialize(de::PathDeserializer::new(&req.state().match_params))
.map_err(|_| ParsePathError)?,
))
}
}
#[async_trait::async_trait]
impl<'a, T: DeserializeOwned> FromRequest<'a> for Path<T> {
async fn from_request(req: &'a Request, _body: &mut RequestBody) -> Result<Self> {
Self::internal_from_request(req).await.map_err(Into::into)
}
}