Struct Server

pub struct Server { /* private fields */ }

Listens on a random port, running the given function to handle each request.

See the crate documentation for an example.

Implementations

impl Server

pub async fn new<H: Handler + Clone + Send + Sync + 'static>( handler: H, ) -> Result<Self, Error>

Creates a new HTTP server on a random port running the given handler. The handler will be called on every request, and the total request count can be retrieved with server.req_count().

The server can be safely cloned and used from multiple threads. When the final reference to the server is dropped, the server will be shut down and all pending requests will be aborted. Aborting the server will happen in the background and will not block.

The remote socket address is added as a SocketAddr extension to the request object.

pub fn addr(&self) -> SocketAddr

Returns the socket address the server is listening on.

pub fn url(&self, path_and_query: &str) -> Uri

Returns a valid request URL for the given path and query string.

pub fn req_count(&self) -> u64

Returns the number of requests handled by the server. This value is incremented after the request handler has finished, but before the response has been sent.

At the end of tests, this should be asserted to be equal to the amount of requests sent.

Any panics in the request handler may result in the counter becoming out of sync.

pub async fn await_req_count( &self, target_count: u64, timeout: Duration, ) -> Result<(), Error>

Await req_count reaching a certain number. This polls every 10ms and times out after the given duration.

pub fn concurrent_req_count(&self) -> u64

Returns the number of concurrent requests currently being handled by the server. A concurrent request is measured by incrementing the counter before the request handler is called, and decrementing it after the request handler has finished. The response may still be in the process of being sent when the counter is decremented.

Any panics in the request handler may result in the counter becoming out of sync.

pub async fn await_concurrent_req_count( &self, target_count: u64, timeout: Duration, ) -> Result<(), Error>

Await concurrent_req_count reaching a certain number. This polls every 10ms and times out after the given duration.

pub fn close(&self)

close kills the server and aborts all pending requests. This does not block for all requests to finish.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Server

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

Formats the value using the given formatter.

impl Drop for Server

fn drop(&mut self)

Executes the destructor for this type.