pub struct Json<T>(pub T);
Expand description
JSON extractor and response.
To extract the specified type of JSON from the body, T
must implement
serde::Deserialize
.
Errors
use poem::{
handler,
http::{header, Method, StatusCode},
post,
test::TestClient,
web::Json,
Endpoint, Request, Route,
};
use serde::Deserialize;
#[derive(Deserialize)]
struct User {
name: String,
}
#[handler]
async fn index(Json(user): Json<User>) -> String {
format!("welcome {}!", user.name)
}
let app = Route::new().at("/", post(index));
let cli = TestClient::new(app);
let resp = cli
.post("/")
.header(header::CONTENT_TYPE, "application/json")
.body(r#"{"name": "foo"}"#)
.send()
.await;
resp.assert_status_is_ok();
resp.assert_text("welcome foo!").await;
Response
To serialize the specified type to JSON, T
must implement
serde::Serialize
.
use poem::{
get, handler, http::StatusCode, test::TestClient, web::Json, Endpoint, Request, Route,
};
use serde::Serialize;
#[derive(Serialize)]
struct User {
name: String,
}
#[handler]
async fn index() -> Json<User> {
Json(User {
name: "foo".to_string(),
})
}
let app = Route::new().at("/", get(index));
let cli = TestClient::new(app);
let resp = cli.get("/").send().await;
resp.assert_status_is_ok();
resp.assert_text(r#"{"name":"foo"}"#).await;
Tuple Fields
0: T
Trait Implementations
sourceimpl<'a, T: DeserializeOwned> FromRequest<'a> for Json<T>
impl<'a, T: DeserializeOwned> FromRequest<'a> for Json<T>
sourcefn from_request<'life0, 'async_trait>(
req: &'a Request,
body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
fn from_request<'life0, 'async_trait>(
req: &'a Request,
body: &'life0 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>> where
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
Extract from request head and body.
sourceimpl<T: Serialize + Send> IntoResponse for Json<T>
impl<T: Serialize + Send> IntoResponse for Json<T>
sourcefn into_response(self) -> Response
fn into_response(self) -> Response
Consume itself and return Response
.
sourcefn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Self: Sized,
fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self> where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Self: Sized,
Wrap an impl IntoResponse
to add a header. Read more
sourcefn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,
Self: Sized,
fn with_content_type<V>(self, content_type: V) -> WithContentType<Self> where
V: TryInto<HeaderValue>,
Self: Sized,
Wrap an impl IntoResponse
to with a new content type. Read more
sourcefn with_status(self, status: StatusCode) -> WithStatus<Self> where
Self: Sized,
fn with_status(self, status: StatusCode) -> WithStatus<Self> where
Self: Sized,
Wrap an impl IntoResponse
to set a status code. Read more
impl<T: Eq> Eq for Json<T>
impl<T> StructuralEq for Json<T>
impl<T> StructuralPartialEq for Json<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for Json<T> where
T: RefUnwindSafe,
impl<T> Send for Json<T> where
T: Send,
impl<T> Sync for Json<T> where
T: Sync,
impl<T> Unpin for Json<T> where
T: Unpin,
impl<T> UnwindSafe for Json<T> where
T: UnwindSafe,
Blanket Implementations
impl<T, A, P> Access<T> for P where
A: Access<T>,
P: Deref<Target = A>,
impl<T, A, P> Access<T> for P where
A: Access<T>,
P: Deref<Target = A>,
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, A> DynAccess<T> for A where
A: Access<T>,
<A as Access<T>>::Guard: 'static,
impl<T, A> DynAccess<T> for A where
A: Access<T>,
<A as Access<T>>::Guard: 'static,
fn load(&self) -> DynGuard<T>
fn load(&self) -> DynGuard<T>
The equivalent of [Access::load
].
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> FutureExt for T
impl<T> FutureExt for T
sourcefn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
sourcefn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> IntoResult<T> for T where
T: IntoResponse,
impl<T> IntoResult<T> for T where
T: IntoResponse,
sourcefn into_result(self) -> Result<T, Error>
fn into_result(self) -> Result<T, Error>
Consumes this value returns a poem::Result<T>
.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more