Struct MatrixMock

pub struct MatrixMock<'a> { /* private fields */ }

Available on crate feature testing and non-WebAssembly only.

A wrapper for a Mock as well as a MockServer, allowing us to call Mock::mount or Mock::mount_as_scoped without having to pass the MockServer reference (i.e. call mount() instead of mount(&server)).

Implementations

impl MatrixMock<'_>

pub fn expect<T: Into<Times>>(self, num_calls: T) -> Self

Set an expectation on the number of times this MatrixMock should match in the current test case.

Expectations are verified when the server is shutting down: if the expectation is not satisfied, the MatrixMockServer will panic and the error_message is shown.

By default, no expectation is set for MatrixMocks.

pub fn named(self, name: impl Into<String>) -> Self

Assign a name to your mock.

The mock name will be used in error messages (e.g. if the mock expectation is not satisfied) and debug logs to help you identify what failed.

pub fn mock_once(self) -> Self

Respond to a response of this endpoint exactly once.

After it’s been called, subsequent responses will hit the next handler or a 404.

Also verifies that it’s been called once.

pub fn never(self) -> Self

Makes sure the endpoint is never reached.

pub fn up_to_n_times(self, num: u64) -> Self

Specify an upper limit to the number of times you would like this MatrixMock to respond to incoming requests that satisfy the conditions imposed by your matchers.

pub async fn mount(self)

Mount a MatrixMock on the attached server.

The MatrixMock will remain active until the MatrixMockServer is shut down. If you want to control or limit how long your MatrixMock stays active, check out Self::mount_as_scoped.

pub async fn mount_as_scoped(self) -> MockGuard

Mount a MatrixMock as scoped on the attached server.

When using Self::mount, your MatrixMocks will be active until the MatrixMockServer is shut down.

When using mount_as_scoped, your MatrixMocks will be active as long as the returned MockGuard is not dropped.

When the returned MockGuard is dropped, MatrixMockServer will verify that the expectations set on the scoped MatrixMock were verified - if not, it will panic.