Struct poem::test::TestRequestBuilder

source · [−]

pub struct TestRequestBuilder<'a, E> { /* private fields */ }

This is supported on crate feature test only.

Expand description

A request builder for testing.

Implementations

impl<'a, E> TestRequestBuilder<'a, E> where
E: Endpoint,

pub fn query(self, name: impl Into<String>, value: &impl Serialize) -> Self

Sets the query string for this request.

Example

use poem::{handler, test::TestClient, web::Query, Route};
use serde::Deserialize;

#[derive(Deserialize)]
struct Params {
    key: String,
    value: i32,
}

#[handler]
fn index(Query(params): Query<Params>) -> String {
    format!("{}={}", params.key, params.value)
}

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

let resp = cli
    .get("/")
    .query("key", &"a")
    .query("value", &10)
    .send()
    .await;
resp.assert_status_is_ok();
resp.assert_text("a=10").await;

Sets the header value for this request.

pub fn typed_header<T: Header>(self, header: T) -> Self

Inserts a typed header to this request.

pub fn content_type(self, content_type: impl AsRef<str>) -> Self

Sets the content type for this request.

pub fn body(self, body: impl Into<Body>) -> Self

Sets the body for this request.

pub fn body_json(self, body: &impl Serialize) -> Self

Sets the JSON body for this request with application/json content type.

pub fn form(self, form: &impl Serialize) -> Self

Sets the form data for this request with application/x-www-form-urlencoded content type.

pub fn multipart(self, form: TestForm) -> Self

Sets the multipart body for this request with multipart/form-data content type.

pub fn data<T>(self, data: T) -> Self where
T: Send + Sync + 'static,

Sets the extension data for this request.

Example

use poem::{handler, test::TestClient, web::Data, Route};

#[handler]
fn index(Data(value): Data<&i32>) -> String {
    value.to_string()
}

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

let resp = cli.get("/").data(100i32).send().await;
resp.assert_status_is_ok();
resp.assert_text("100").await;

pub async fn send(self) -> TestResponse

Send this request to endpoint to get the response.

Auto Trait Implementations

impl<'a, E> !RefUnwindSafe for TestRequestBuilder<'a, E>

impl<'a, E> Send for TestRequestBuilder<'a, E> where
E: Sync,

impl<'a, E> Sync for TestRequestBuilder<'a, E> where
E: Sync,

impl<'a, E> Unpin for TestRequestBuilder<'a, E>

impl<'a, E> !UnwindSafe for TestRequestBuilder<'a, E>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

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

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

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

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

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 T where
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> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
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 T where
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 T where
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