Struct StubClient

pub struct StubClient { /* private fields */ }

A client which allows you to stub out the response to a request explicitly.

Examples

use reqwest_mock::{Client, Method, StubClient, StubDefault, StubSettings, StubStrictness, Url};

let mut client = StubClient::new(StubSettings {
    // If a request without a corresponding stub is made we want an error
    // to be returned when our code executes the request.
    default: StubDefault::Error,

    // We want the `StubClient` to compare actual requests and provided
    // mocks by their method and their url.
    strictness: StubStrictness::MethodUrl,
});

// Mock a request.
client
    .stub(Url::parse("http://example.com/mocking").unwrap())
        .method(Method::GET)
    .response()
        .body("Mocking is fun!")
        .mock();

let response = client.get("http://example.com/mocking").send().unwrap();
assert_eq!(response.body_to_utf8().unwrap(), "Mocking is fun!".to_string());

Implementations

impl StubClient

pub fn new(stub_settings: StubSettings) -> Self

Create a new instance of StubClient.

Please consult StubSettings for more information about the possible settings.

pub fn stub<'cl>(&'cl mut self, url: Url) -> RequestStubber<'cl>

Provide a stub for a request to the provided url.

This will return a RequestStubber, which in a first step will allow you to specify the full details of the request. Make sure that they match the StubStrictness provided in the settings.

After you are finished specifying the details of the matching request, call response() to return a ResponseStubber instance and start specifying the response. Finally use ResponseStubber::mock() to register the mock into the client.

Trait Implementations

impl Client for StubClient

fn execute( &self, config: Option<&ClientConfig>, request: Request, ) -> Result<Response, Error>

Execute a request.

fn config(&self) -> &ClientConfig

Returns a immutable reference to the internal config.

fn config_mut(&mut self) -> &mut ClientConfig

Returns a mutable reference to the internal config.

fn get<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a GET request to a URL.

fn post<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a POST request to a URL.

fn put<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a PUT request to a URL.

fn patch<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a PATCH request to a URL.

fn delete<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a DELETE request to a URL.

fn head<'cl, U: IntoUrl>(&'cl self, url: U) -> RequestBuilder<'cl, Self>

Convenience method to make a HEAD request to a URL.

fn request<'cl, U: IntoUrl>( &'cl self, method: Method, url: U, ) -> RequestBuilder<'cl, Self>

Returns a RequestBuilder for the given method and URL, which allows for further configuration of the request, like including additional headers, and sending it.

impl From<StubClient> for GenericClient

fn from(c: StubClient) -> Self

Converts to this type from the input type.