Struct mockito::Mock

source · [−]

pub struct Mock { /* private fields */ }

Expand description

Stores information about a mocked request. Should be initialized via mockito::mock().

Implementations

source

impl Mock

source

pub fn match_query<M: Into<Matcher>>(self, query: M) -> Self

Allows matching against the query part when responding with a mock.

Note that you can also specify the query as part of the path argument in a mock call, in which case an exact match will be performed. Any future calls of Mock#match_query will override the query matcher.

Example

use mockito::{mock, Matcher};

// This will match requests containing the URL-encoded
// query parameter `greeting=good%20day`
let _m1 = mock("GET", "/test")
  .match_query(Matcher::UrlEncoded("greeting".into(), "good day".into()))
  .create();

// This will match requests containing the URL-encoded
// query parameters `hello=world` and `greeting=good%20day`
let _m2 = mock("GET", "/test")
  .match_query(Matcher::AllOf(vec![
    Matcher::UrlEncoded("hello".into(), "world".into()),
    Matcher::UrlEncoded("greeting".into(), "good day".into())
  ]))
  .create();

// You can achieve similar results with the regex matcher
let _m3 = mock("GET", "/test")
  .match_query(Matcher::Regex("hello=world".into()))
  .create();

source

pub fn match_header<M: Into<Matcher>>(self, field: &str, value: M) -> Self

Allows matching a particular request header when responding with a mock.

When matching a request, the field letter case is ignored.

Example

use mockito::mock;

let _m = mock("GET", "/").match_header("content-type", "application/json");

Like most other Mock methods, it allows chanining:

Example

use mockito::mock;

let _m = mock("GET", "/")
  .match_header("content-type", "application/json")
  .match_header("authorization", "password");

source

pub fn match_body<M: Into<Matcher>>(self, body: M) -> Self

Allows matching a particular request body when responding with a mock.

Example

use mockito::mock;

let _m1 = mock("POST", "/").match_body(r#"{"hello": "world"}"#).with_body("json").create();
let _m2 = mock("POST", "/").match_body("hello=world").with_body("form").create();

// Requests passing `{"hello": "world"}` inside the body will be responded with "json".
// Requests passing `hello=world` inside the body will be responded with "form".

// Create a temporary file
use std::env;
use std::fs::File;
use std::io::Write;
use std::path::Path;
use rand;
use rand::Rng;

let random_bytes: Vec<u8> = (0..1024).map(|_| rand::random::<u8>()).collect();

let mut tmp_file = env::temp_dir();
tmp_file.push("test_file.txt");
let mut f_write = File::create(tmp_file.clone()).unwrap();
f_write.write_all(random_bytes.as_slice()).unwrap();
let mut f_read = File::open(tmp_file.clone()).unwrap();


// the following are equivalent ways of defining a mock matching
// a binary payload
let _b1 = mock("POST", "/").match_body(tmp_file.as_path()).create();
let _b3 = mock("POST", "/").match_body(random_bytes).create();
let _b2 = mock("POST", "/").match_body(&mut f_read).create();

source

pub fn with_status(self, status: usize) -> Self

Sets the status code of the mock response. The default status code is 200.

Example

use mockito::mock;

let _m = mock("GET", "/").with_status(201);

source

pub fn with_header(self, field: &str, value: &str) -> Self

Sets a header of the mock response.

Example

use mockito::mock;

let _m = mock("GET", "/").with_header("content-type", "application/json");

source

pub fn with_body<StrOrBytes: AsRef<[u8 ]>>(self, body: StrOrBytes) -> Self

Sets the body of the mock response. Its Content-Length is handled automatically.

Example

use mockito::mock;

let _m = mock("GET", "/").with_body("hello world");

source

pub fn with_body_from_fn(
self,
cb: impl Fn(&mut dyn Write) -> Result<()> + Send + Sync + 'static
) -> Self

Sets the body of the mock response dynamically. The response will use chunked transfer encoding.

The function must be thread-safe. If it’s a closure, it can’t be borrowing its context. Use move closures and Arc to share any data.

Example

use mockito::mock;

let _m = mock("GET", "/").with_body_from_fn(|w| w.write_all(b"hello world"));

source

pub fn with_body_from_file(self, path: impl AsRef<Path>) -> Self

Sets the body of the mock response from the contents of a file stored under path. Its Content-Length is handled automatically.

Example

use mockito::mock;

let _m = mock("GET", "/").with_body_from_file("tests/files/simple.http");

source

pub fn expect(self, hits: usize) -> Self

Sets the expected amount of requests that this mock is supposed to receive. This is only enforced when calling the assert method. Defaults to 1 request.

source

pub fn expect_at_least(self, hits: usize) -> Self

Sets the minimum amount of requests that this mock is supposed to receive. This is only enforced when calling the assert method.

source

pub fn expect_at_most(self, hits: usize) -> Self

Sets the maximum amount of requests that this mock is supposed to receive. This is only enforced when calling the assert method.

source

pub fn assert(&self)

Asserts that the expected amount of requests (defaults to 1 request) were performed.

source

pub fn matched(&self) -> bool

Returns whether the expected amount of requests (defaults to 1) were performed.

source

pub fn create(self) -> Self

Registers the mock to the server - your mock will be served only after calling this method.

Example

use mockito::mock;

let _m = mock("GET", "/").with_body("hello world").create();

Trait Implementations

source

impl Clone for Mock

source

fn clone(&self) -> Mock

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Mock

source

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

Formats the value using the given formatter. Read more

source

impl Display for Mock

source

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

Formats the value using the given formatter. Read more

source

impl Drop for Mock

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl PartialEq<Mock> for Mock

source

fn eq(&self, other: &Mock) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

source

fn ne(&self, other: &Mock) -> bool

This method tests for !=.

source

impl StructuralPartialEq for Mock

Auto Trait Implementations

impl !RefUnwindSafe for Mock

impl Send for Mock

impl Sync for Mock

impl Unpin for Mock

impl !UnwindSafe for Mock

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct mockito::Mock

Implementations

impl Mock

pub fn match_query<M: Into<Matcher>>(self, query: M) -> Self

pub fn match_header<M: Into<Matcher>>(self, field: &str, value: M) -> Self

pub fn match_body<M: Into<Matcher>>(self, body: M) -> Self

pub fn with_status(self, status: usize) -> Self

pub fn with_header(self, field: &str, value: &str) -> Self

pub fn with_body<StrOrBytes: AsRef<[u8]>>(self, body: StrOrBytes) -> Self

pub fn with_body_from_fn( self, cb: impl Fn(&mut dyn Write) -> Result<()> + Send + Sync + 'static) -> Self

pub fn with_body_from_file(self, path: impl AsRef<Path>) -> Self

pub fn expect(self, hits: usize) -> Self

pub fn expect_at_least(self, hits: usize) -> Self

pub fn expect_at_most(self, hits: usize) -> Self

pub fn assert(&self)

pub fn matched(&self) -> bool

pub fn create(self) -> Self

Trait Implementations

impl Clone for Mock

fn clone(&self) -> Mock

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

impl Debug for Mock

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

impl Display for Mock

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

impl Drop for Mock

fn drop(&mut self)

impl PartialEq<Mock> for Mock

fn eq(&self, other: &Mock) -> bool

fn ne(&self, other: &Mock) -> bool

impl StructuralPartialEq for Mock

Auto Trait Implementations

impl !RefUnwindSafe for Mock

impl Send for Mock

impl Sync for Mock

impl Unpin for Mock

impl !UnwindSafe for Mock

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

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

type Error = Infallible

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

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

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

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

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

pub fn with_body<StrOrBytes: AsRef<[u8 ]>>(self, body: StrOrBytes) -> Self

pub fn with_body_from_fn(
self,
cb: impl Fn(&mut dyn Write) -> Result<()> + Send + Sync + 'static
) -> Self

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

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

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

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

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

impl<T> ToString for T where
T: Display + ?Sized,

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,