Struct poem::web::Json

source · [−]

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

impl<T: Clone> Clone for Json<T>

fn clone(&self) -> Json<T>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Json<T>

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

Formats the value using the given formatter. Read more

impl<T: Default> Default for Json<T>

fn default() -> Json<T>

Returns the “default value” for a type. Read more

impl<T> Deref for Json<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Json<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'a, T: DeserializeOwned> FromRequest<'a> for Json<T>

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.

impl<T: Serialize + Send> IntoResponse for Json<T>

fn into_response(self) -> Response

Consume itself and return Response.

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

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

fn with_status(self, status: StatusCode) -> WithStatus<Self>where
Self: Sized,

Wrap an impl IntoResponse to set a status code. Read more

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>where
Self: Sized,

Wrap an impl IntoResponse to set a body. Read more

impl<T: PartialEq> PartialEq<Json<T>> for Json<T>

fn eq(&self, other: &Json<T>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. 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 Pwhere
A: Access<T>,
P: Deref<Target = A>,

type Guard = <A as Access<T>>::Guard

A guard object containing the value and keeping it alive. Read more

fn load(&self) -> <P as Access<T>>::Guard

The loading method. Read more

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> AnyEq for Twhere
T: Any + PartialEq<T>,

fn equals(&self, other: &(dyn Any + 'static)) -> bool

fn as_any(&self) -> &(dyn Any + 'static)

impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self>

impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,

fn implicit(
    self,
    class: Class,
    constructed: bool,
    tag: u32
) -> TaggedParser<'a, Implicit, Self>

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T, A> DynAccess<T> for Awhere
A: Access<T>,
<A as Access<T>>::Guard: 'static,

fn load(&self) -> DynGuard<T>

The equivalent of [Access::load].

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoResult<T> for Twhere
T: IntoResponse,

fn into_result(self) -> Result<T, Error>

Consumes this value returns a poem::Result<T>.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Formattable for Twhere
T: Deref,
<T as Deref>::Target: Formattable,

impl<T> Parsable for Twhere
T: Deref,
<T as Deref>::Target: Parsable,