Struct warp::test::RequestBuilder

source ·

pub struct RequestBuilder { /* private fields */ }

Expand description

A request builder for testing filters.

See module documentation for an overview.

Implementations

source

impl RequestBuilder

source

pub fn method(self, method: &str) -> Self

Sets the method of this builder.

The default if not set is GET.

Example

let req = warp::test::request()
    .method("POST");

Panic

This panics if the passed string is not able to be parsed as a valid Method.

source

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

Sets the request path of this builder.

The default is not set is /.

Example

let req = warp::test::request()
    .path("/todos/33");

Panic

This panics if the passed string is not able to be parsed as a valid Uri.

Set a header for this request.

Example

let req = warp::test::request()
    .header("accept", "application/json");

Panic

This panics if the passed strings are not able to be parsed as a valid HeaderName and HeaderValue.

source

pub fn body(self, body: impl AsRef<[u8]>) -> Self

Set the bytes of this request body.

Default is an empty body.

Example

let req = warp::test::request()
    .body("foo=bar&baz=quux");

source

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

Set the bytes of this request body by serializing a value into JSON.

Example

let req = warp::test::request()
    .json(&true);

source

pub fn filter<F>(
 self,
 f: &F
) -> Result<<F::Extract as OneOrTuple>::Output, F::Error>where
 F: Filter,
 F::Future: Send + 'static,
 F::Extract: OneOrTuple + Send + 'static,
 F::Error: Send + 'static,

Tries to apply the Filter on this request.

Example

let param = warp::path::param::<u32>();

let ex = warp::test::request()
    .path("/41")
    .filter(&param)
    .unwrap();

assert_eq!(ex, 41);

assert!(
    warp::test::request()
        .path("/foo")
        .filter(&param)
        .is_err()
);

source

pub fn matches<F>(self, f: &F) -> boolwhere
 F: Filter,
 F::Future: Send + 'static,
 F::Extract: Send + 'static,
 F::Error: Send + 'static,

Returns whether the Filter matches this request, or rejects it.

Example

let get = warp::get2();
let post = warp::post2();

assert!(
    warp::test::request()
        .method("GET")
        .matches(&get)
);

assert!(
    !warp::test::request()
        .method("GET")
        .matches(&post)
);

source