Struct axum_test::TestServer

pub struct TestServer { /* private fields */ }

The TestServer represents your application, running as a web server, and you can make web requests to your application.

For most people’s needs, this is where to start when writing a test. This allows you Allowing you to create new requests that will go to this server.

You can make a request against the TestServer by calling the get, post, put, delete, and patch methods (you can also use method).

Implementations

impl TestServer

pub fn new(app: IntoMakeService<Router>) -> Result<Self>

This will take the given app, and run it. It will use a randomly selected port for running.

This is the same as creating a new TestServer with a configuration, and passing TestServerConfig::default().

pub fn new_with_config( app: IntoMakeService<Router>, options: TestServerConfig ) -> Result<Self>

This very similar to TestServer::new(), however you can customise some of the configuration. This includes which port to run on, or default settings.

See the TestServerConfig for more information on each configuration setting.

pub fn clear_cookies(&mut self)

Clears all of the cookies stored internally.

pub fn add_cookies(&mut self, cookies: CookieJar)

Adds extra cookies to be used on all future requests.

Any cookies which have the same name as the new cookies, will get replaced.

pub fn add_cookie(&mut self, cookie: Cookie<'_>)

Adds a cookie to be included on all future requests.

If a cookie with the same name already exists, then it will be replaced.

pub fn get(&self, path: &str) -> TestRequest

Creates a HTTP GET request to the path.

pub fn post(&self, path: &str) -> TestRequest

Creates a HTTP POST request to the given path.

pub fn patch(&self, path: &str) -> TestRequest

Creates a HTTP PATCH request to the path.

pub fn put(&self, path: &str) -> TestRequest

Creates a HTTP PUT request to the path.

pub fn delete(&self, path: &str) -> TestRequest

Creates a HTTP DELETE request to the path.

pub fn method(&self, method: Method, path: &str) -> TestRequest

Creates a HTTP request, to the path given, using the given method.

Trait Implementations

impl Debug for TestServer

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

Formats the value using the given formatter.