Struct axum_test::TestResponse

pub struct TestResponse { /* private fields */ }

The TestResponse represents the result of a TestRequest. It is returned when you call await on a TestRequest object.

Inside are the contents of the response, the status code, and some debugging information. You can use this to deserialise the data returned into a specific format (i.e. deserialising from JSON), and validating the response looks how you expect.

Implementations

impl TestResponse

pub fn request_url<'a>(&'a self) -> &'a str

The URL that was used to produce this response.

pub fn bytes<'a>(&'a self) -> &'a [u8]

Returns the raw underlying response, as it’s raw bytes.

pub fn text(&self) -> String

Returns the underlying response, as a raw UTF-8 string.

pub fn status_code(&self) -> StatusCode

The status_code of the response.

pub fn maybe_header<N>(&self, header_name: N) -> Option<HeaderValue>where N: AsHeaderName,

Finds a header with the given name. If there are multiple headers with the same name, then only the first will be returned.

None is returned when no header was found.

pub fn header<N>(&self, header_name: N) -> HeaderValuewhere N: AsHeaderName + Display + Clone,

Finds a header with the given name. If there are multiple headers with the same name, then only the first will be returned.

If no header is found, then this will panic.

pub fn iter_headers<'a>( &'a self ) -> impl Iterator<Item = (&'a HeaderName, &'a HeaderValue)>

Iterates over all of the headers contained in the response.

pub fn iter_headers_by_name<'a, N>( &'a self, header_name: N ) -> impl Iterator<Item = &'a HeaderValue>where N: AsHeaderName,

Iterates over all of the headers for a specific name, contained in the response.

pub fn maybe_cookie(&self, cookie_name: &str) -> Option<Cookie<'static>>

pub fn cookie(&self, cookie_name: &str) -> Cookie<'static>

pub fn cookies(&self) -> CookieJar

Returns all of the cookies contained in the response, within a CookieJar object.

See the cookie crate for details.

pub fn iter_cookies<'a>(&'a self) -> impl Iterator<Item = Cookie<'a>>

Iterate over all of the cookies in the response.

pub fn json<T>(&self) -> Twhere for<'de> T: Deserialize<'de>,

Reads the response from the server as JSON text, and then deserialise the contents into the structure given.

pub fn assert_text<C>(self, other: C) -> Selfwhere C: AsRef<str>,

This performs an assertion comparing the whole body of the response, against the text provided.

pub fn assert_json<T>(self, other: &T) -> Selfwhere for<'de> T: Deserialize<'de> + PartialEq<T> + Debug,

Deserializes the contents of the request, and asserts if it matches the value given.

If other does not match, then this will panic.

Other can be your own Serde model that you wish to deserialise the data into, or it can be a json! blob created using the ::serde_json::json macro.

pub fn assert_status_bad_request(self) -> Self

pub fn assert_status_not_found(self) -> Self

pub fn assert_status_ok(self) -> Self

pub fn assert_status_not_ok(self) -> Self

pub fn assert_status(self, status_code: StatusCode) -> Self

pub fn assert_not_status(self, status_code: StatusCode) -> Self

Trait Implementations

impl Clone for TestResponse

fn clone(&self) -> TestResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestResponse

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

Formats the value using the given formatter.