Struct ResponseStub 

pub struct ResponseStub {
    pub method: String,
    pub path: String,
    pub status: u16,
    pub headers: HashMap<String, String>,
    pub body: Value,
    pub latency_ms: Option<u64>,
    pub state_machine: Option<StateMachineConfig>,
    pub fault_injection: Option<StubFaultInjectionConfig>,
}

A response stub for mocking API endpoints

Fields

method: String

HTTP method (GET, POST, PUT, DELETE, etc.)

path: String

Path pattern (supports {{path_params}})

status: u16

HTTP status code

headers: HashMap<String, String>

Response headers

body: Value

Response body (supports templates like {{uuid}}, {{faker.name}})

latency_ms: Option<u64>

Optional latency in milliseconds

state_machine: Option<StateMachineConfig>

Optional state machine configuration for stateful behavior When set, responses will vary based on resource state

fault_injection: Option<StubFaultInjectionConfig>

Optional fault injection configuration for error simulation When set, can inject errors, timeouts, or connection failures

Implementations

impl ResponseStub

pub fn new( method: impl Into<String>, path: impl Into<String>, body: Value, ) -> Self

Create a new response stub

pub fn status(self, status: u16) -> Self

Set the HTTP status code

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a response header

pub fn latency(self, ms: u64) -> Self

Set response latency in milliseconds

pub fn with_state_machine(self, config: StateMachineConfig) -> Self

Set state machine configuration for stateful behavior

pub fn has_state_machine(&self) -> bool

Check if this stub has state machine configuration

pub fn state_machine(&self) -> Option<&StateMachineConfig>

Get state machine configuration

pub fn apply_state_override(&self, current_state: &str) -> ResponseStub

Apply state-based response override if state machine is configured

This method checks if the stub has state machine configuration and applies state-based response overrides based on the current state.

Returns a modified stub with state-specific overrides applied, or the original stub if no state machine config or no override for current state.

pub fn with_fault_injection(self, config: StubFaultInjectionConfig) -> Self

Set fault injection configuration

pub fn has_fault_injection(&self) -> bool

Check if this stub has fault injection configured

pub fn fault_injection(&self) -> Option<&StubFaultInjectionConfig>

Get fault injection configuration

Trait Implementations

impl Clone for ResponseStub

fn clone(&self) -> ResponseStub

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseStub

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResponseStub

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseStub

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.