Struct zebra_test::mock_service::MockServiceBuilder

pub struct MockServiceBuilder {
    proxy_channel_size: Option<usize>,
    max_request_delay: Option<Duration>,
}

A builder type to create a MockService.

Allows changing specific parameters used by the MockService, if necessary. The default parameters should be reasonable for most cases.

Fields

proxy_channel_size: Option<usize>

max_request_delay: Option<Duration>

Implementations

impl MockServiceBuilder

pub fn with_proxy_channel_size(self, size: usize) -> Self

Configure the size of the proxy channel used for sending intercepted requests.

This determines the maximum amount of requests that are kept in queue before the oldest request is dropped. This means that any tests that receive too many requests might ignore some requests if this parameter isn’t properly configured.

The default value of 100 should be enough for most cases.

Example

let mock_service = MockService::build()
    .with_proxy_channel_size(100)
    .for_prop_tests();

pub fn with_max_request_delay(self, max_request_delay: Duration) -> Self

Configure the time to wait for a request before considering no requests will be received.

This determines the maximum amount of time that the MockService will wait for a request to be received before considering that a request will not be received.

The default value of 25 ms should be enough for most cases.

Example

let mock_service = MockService::build()
    .with_max_request_delay(Duration::from_millis(25))
    .for_unit_tests();

pub fn for_prop_tests<Request, Response, Error>( self ) -> MockService<Request, Response, PropTestAssertion, Error>

Create a MockService to be used in [mod@proptest]s.

The assertions performed by MockService use the macros provided by [mod@proptest], like prop_assert.

pub fn for_unit_tests<Request, Response, Error>( self ) -> MockService<Request, Response, PanicAssertion, Error>

Create a MockService to be used in Rust unit tests.

The assertions performed by MockService use the macros provided by default in Rust, like assert.

pub fn finish<Request, Response, Assertion, Error>( self ) -> MockService<Request, Response, Assertion, Error>

An internal helper method to create the actual MockService.

Note that this is used by both Self::for_prop_tests and Self::for_unit_tests, the only difference being the Assertion generic type parameter, which Rust infers automatically.

Trait Implementations

impl Default for MockServiceBuilder

fn default() -> MockServiceBuilder

Returns the “default value” for a type.