Struct actix_test::TestServer

pub struct TestServer { /* private fields */ }

A basic HTTP server controller that simplifies the process of writing integration tests for Actix Web applications.

See start for usage example.

Implementations

impl TestServer

pub fn addr(&self) -> SocketAddr

Construct test server url

pub fn url(&self, uri: &str) -> String

Construct test server url

pub fn get(&self, path: impl AsRef<str>) -> ClientRequest

Create GET request.

pub fn post(&self, path: impl AsRef<str>) -> ClientRequest

Create POST request.

pub fn head(&self, path: impl AsRef<str>) -> ClientRequest

Create HEAD request.

pub fn put(&self, path: impl AsRef<str>) -> ClientRequest

Create PUT request.

pub fn patch(&self, path: impl AsRef<str>) -> ClientRequest

Create PATCH request.

pub fn delete(&self, path: impl AsRef<str>) -> ClientRequest

Create DELETE request.

pub fn options(&self, path: impl AsRef<str>) -> ClientRequest

Create OPTIONS request.

pub fn request(&self, method: Method, path: impl AsRef<str>) -> ClientRequest

Connect request with given method and path.

pub async fn load_body<S>( &mut self, response: ClientResponse<S> ) -> Result<Bytes, PayloadError>

where S: Stream<Item = Result<Bytes, PayloadError>> + Unpin + 'static,

pub async fn ws_at( &mut self, path: &str ) -> Result<Framed<impl AsyncRead + AsyncWrite, Codec>, WsClientError>

Connect to WebSocket server at a given path.

pub async fn ws( &mut self ) -> Result<Framed<impl AsyncRead + AsyncWrite, Codec>, WsClientError>

Connect to a WebSocket server.

pub fn client_headers(&mut self) -> Option<&mut HeaderMap>

Get default HeaderMap of Client.

Returns Some(&mut HeaderMap) when Client object is unique (No other clone of client exists at the same time).

pub async fn stop(self)

Stop HTTP server.

Waits for spawned Server and System to shutdown (force) shutdown.

Trait Implementations

impl Drop for TestServer

fn drop(&mut self)

Executes the destructor for this type.