Struct poem::web::Query

pub struct Query<T>(pub T);

An extractor that can deserialize some type from query string.

Errors

• ParseQueryError

Example

use poem::{
    get, handler,
    http::{Method, StatusCode, Uri},
    test::TestClient,
    web::Query,
    Endpoint, Request, Route,
};
use serde::Deserialize;

#[derive(Deserialize)]
struct CreateDocument {
    title: String,
    content: String,
}

#[handler]
fn index(Query(CreateDocument { title, content }): Query<CreateDocument>) -> String {
    format!("{}:{}", title, content)
}

let app = Route::new().at("/", get(index).post(index));
let cli = TestClient::new(app);

let resp = cli
    .get("/")
    .query("title", &"foo")
    .query("content", &"bar")
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("foo:bar").await;

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Query<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Query<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Query<T>

fn default() -> Query<T>

Returns the “default value” for a type.

impl<T> Deref for Query<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Query<T>

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

Mutably dereferences the value.

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

async fn from_request(req: &'a Request, _body: &mut RequestBody) -> Result<Self>

Extract from request head and body.

fn from_request_without_body( req: &'a Request ) -> impl Future<Output = Result<Self>> + Send

Extract from request head.

impl<T: PartialEq> PartialEq for Query<T>

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

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

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.

impl<T: Eq> Eq for Query<T>

impl<T> StructuralPartialEq for Query<T>