Skip to main content

TestClient

Struct TestClient 

Source
pub struct TestClient<H> { /* private fields */ }
Expand description

Test client for in-process HTTP testing.

TestClient wraps a handler and provides an HTTP-like interface for testing without network overhead. It maintains a cookie jar for session persistence across requests.

§Thread Safety

TestClient is thread-safe and can be shared across test threads. The internal cookie jar is protected by a mutex.

§Example

let client = TestClient::new(my_handler);

// Simple GET request
let response = client.get("/users").send();
assert_eq!(response.status(), StatusCode::OK);

// POST with JSON body
let response = client
    .post("/users")
    .json(&CreateUser { name: "Alice" })
    .send();
assert_eq!(response.status(), StatusCode::CREATED);

// Request with headers
let response = client
    .get("/protected")
    .header("Authorization", "Bearer token123")
    .send();

Implementations§

Source§

impl<H: Handler + 'static> TestClient<H>

Source

pub fn new(handler: H) -> Self

Creates a new test client wrapping the given handler.

§Example
let client = TestClient::new(my_handler);
Source

pub fn with_seed(handler: H, seed: u64) -> Self

Creates a test client with a deterministic seed for the Lab runtime.

Using the same seed produces identical execution order for concurrent operations, enabling reproducible test failures.

§Example
let client = TestClient::with_seed(my_handler, 42);
Source

pub fn seed(&self) -> Option<u64>

Returns the seed used for deterministic testing, if set.

Source

pub fn cookies(&self) -> MutexGuard<'_, CookieJar>

Returns a reference to the cookie jar.

Note: The jar is protected by a mutex, so concurrent access is safe but may block.

Source

pub fn clear_cookies(&self)

Clears all cookies from the jar.

Source

pub fn get(&self, path: &str) -> RequestBuilder<'_, H>

Creates a GET request builder.

Source

pub fn post(&self, path: &str) -> RequestBuilder<'_, H>

Creates a POST request builder.

Source

pub fn put(&self, path: &str) -> RequestBuilder<'_, H>

Creates a PUT request builder.

Source

pub fn delete(&self, path: &str) -> RequestBuilder<'_, H>

Creates a DELETE request builder.

Source

pub fn patch(&self, path: &str) -> RequestBuilder<'_, H>

Creates a PATCH request builder.

Source

pub fn options(&self, path: &str) -> RequestBuilder<'_, H>

Creates an OPTIONS request builder.

Source

pub fn head(&self, path: &str) -> RequestBuilder<'_, H>

Creates a HEAD request builder.

Source

pub fn request(&self, method: Method, path: &str) -> RequestBuilder<'_, H>

Creates a request builder with a custom method.

Source

pub fn override_dependency<T, F, Fut>(&self, f: F)
where T: FromDependency, F: Fn(&RequestContext, &mut Request) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<T, T::Error>> + Send + 'static,

Register a dependency override for this test client.

Source

pub fn override_dependency_value<T>(&self, value: T)
where T: FromDependency,

Register a fixed dependency override value.

Source

pub fn clear_dependency_overrides(&self)

Clear all registered dependency overrides.

Trait Implementations§

Source§

impl<H> Clone for TestClient<H>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<H> Freeze for TestClient<H>

§

impl<H> !RefUnwindSafe for TestClient<H>

§

impl<H> Send for TestClient<H>
where H: Sync + Send,

§

impl<H> Sync for TestClient<H>
where H: Sync + Send,

§

impl<H> Unpin for TestClient<H>

§

impl<H> !UnwindSafe for TestClient<H>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T