Struct TestServerBuilder

pub struct TestServerBuilder { /* private fields */ }

A builder for crate::TestServer. Inside is a crate::TestServerConfig, configured by each method, and then turn into a server by crate::TestServerBuilder::build.

The recommended way to make instances is to call crate::TestServer::builder.

Creating a crate::TestServer

use axum::Router;
use axum_test::TestServerBuilder;

let my_app = Router::new();
let server = TestServerBuilder::new()
    .save_cookies()
    .default_content_type(&"application/json")
    .build(my_app)?;

Creating a crate::TestServerConfig

use axum::Router;
use axum_test::TestServer;
use axum_test::TestServerBuilder;

let my_app = Router::new();
let config = TestServerBuilder::new()
    .save_cookies()
    .default_content_type(&"application/json")
    .into_config();

// Build the Test Server
let server = TestServer::new_with_config(my_app, config)?;

These can be passed to crate::TestServer::new_with_config.

Implementations

impl TestServerBuilder

pub fn new() -> Self

Creates a default TestServerBuilder.

pub fn from_config(config: TestServerConfig) -> Self

pub fn http_transport(self) -> Self

pub fn http_transport_with_ip_port( self, ip: Option<IpAddr>, port: Option<u16>, ) -> Self

pub fn mock_transport(self) -> Self

pub fn transport(self, transport: Transport) -> Self

pub fn save_cookies(self) -> Self

pub fn do_not_save_cookies(self) -> Self

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

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

pub fn expect_success_by_default(self) -> Self

pub fn restrict_requests_with_http_schema(self) -> Self

pub fn into_config(self) -> TestServerConfig

For turning this into a crate::TestServerConfig object, with can be passed to crate::TestServer::new_with_config.

use axum::Router;
use axum_test::TestServer;

let my_app = Router::new();
let config = TestServer::builder()
    .save_cookies()
    .default_content_type(&"application/json")
    .into_config();

// Build the Test Server
let server = TestServer::new_with_config(my_app, config)?;

pub fn build<A>(self, app: A) -> Result<TestServer>

where A: IntoTransportLayer,

Creates a new crate::TestServer, running the application given, and with all settings from this TestServerBuilder applied.

use axum::Router;
use axum_test::TestServer;

let app = Router::new();
let server = TestServer::builder()
    .save_cookies()
    .default_content_type(&"application/json")
    .build(app);

This is the equivalent to building crate::TestServerConfig yourself, and calling crate::TestServer::new_with_config.

Trait Implementations

impl Clone for TestServerBuilder

fn clone(&self) -> TestServerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TestServerBuilder

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

Formats the value using the given formatter.

impl Default for TestServerBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<TestServerBuilder> for TestServerConfig

fn from(builder: TestServerBuilder) -> Self

Converts to this type from the input type.

impl From<TestServerConfig> for TestServerBuilder

fn from(config: TestServerConfig) -> Self

Converts to this type from the input type.