Struct actix_web::test::TestRequest

pub struct TestRequest<S> { /* fields omitted */ }

Test HttpRequest builder

use actix_web::test::TestRequest;

fn index(req: HttpRequest) -> HttpResponse {
    if let Some(hdr) = req.headers().get(header::CONTENT_TYPE) {
        httpcodes::HTTPOk.into()
    } else {
        httpcodes::HTTPBadRequest.into()
    }
}

fn main() {
    let resp = TestRequest::with_header("content-type", "text/plain")
        .run(index).unwrap();
    assert_eq!(resp.status(), StatusCode::OK);

    let resp = TestRequest::default()
        .run(index).unwrap();
    assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}

Methods

impl TestRequest<()>

fn with_uri(path: &str) -> TestRequest<()>

Create TestRequest and set request uri

fn with_header<K, V>(key: K, value: V) -> TestRequest<()> where
    HeaderName: HttpTryFrom<K>,
    HeaderValue: HttpTryFrom<V>, 

Create TestRequest and set header

impl<S> TestRequest<S>

fn with_state(state: S) -> TestRequest<S>

Start HttpRequest build process with application state

fn version(self, ver: Version) -> Self

Set HTTP version of this request

fn method(self, meth: Method) -> Self

Set HTTP method of this request

fn uri(self, path: &str) -> Self

Set HTTP Uri of this request

fn header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: HttpTryFrom<K>,
    HeaderValue: HttpTryFrom<V>, 

Set a header

fn param(self, name: &'static str, value: &'static str) -> Self

Set request path pattern parameter

fn set_payload<B: Into<Binary>>(self, data: B) -> Self

Set request payload

fn finish(self) -> HttpRequest<S>

Complete request creation and generate HttpRequest instance

fn run<H: Handler<S>>(
    self,
    h: H
) -> Result<HttpResponse, <<H as Handler<S>>::Result as Responder>::Error>

This method generates HttpRequest instance and runs handler with generated request.

This method panics is handler returns actor or async result.

fn run_async<H, R, F, E>(self, h: H) -> Result<HttpResponse, E> where
    H: Fn(HttpRequest<S>) -> F + 'static,
    F: Future<Item = R, Error = E> + 'static,
    R: Responder<Error = E> + 'static,
    E: Into<Error> + 'static, 

This method generates HttpRequest instance and runs handler with generated request.

This method panics is handler returns actor.

Trait Implementations

impl Default for TestRequest<()>

fn default() -> TestRequest<()>

Returns the "default value" for a type.