Struct HttpResponse 

pub struct HttpResponse {

    pub status_code: Option<u16>,
    pub headers: Option<HashMap<String, Vec<String>>>,
    pub body: Option<String>,
    pub delay: Option<Delay>,
    pub cookies: Option<HashMap<String, String>>,
    pub reason_phrase: Option<String>,
    pub status_code_range: Option<String>,
    pub trailers: Option<HashMap<String, Vec<String>>>,
    pub generate_from_schema: Option<String>,
    pub connection_options: Option<ConnectionOptions>,
    pub recover_after: Option<RecoverAfter>,
    pub primary: Option<bool>,
    pub extra: Extra,
}

Builder for an HTTP response action.

Example

use mockserver_client::HttpResponse;

let response = HttpResponse::new()
    .status_code(201)
    .header("Location", "/api/users/42")
    .body("{\"id\": 42}");

Fields

status_code: Option<u16>

headers: Option<HashMap<String, Vec<String>>>

body: Option<String>

delay: Option<Delay>

cookies: Option<HashMap<String, String>>

Response cookies (single value per name; emitted as Set-Cookie).

reason_phrase: Option<String>

HTTP reason phrase (e.g. "Not Found"); overrides the default for the status code.

status_code_range: Option<String>

A status-code range to respond with a random status from (e.g. "2xx").

trailers: Option<HashMap<String, Vec<String>>>

Response trailers (HTTP/2 trailing headers), multiple values per key.

generate_from_schema: Option<String>

Generate the response body from an inline/JSON-schema string.

connection_options: Option<ConnectionOptions>

Connection-level options (chunking, content-length, socket close, …).

recover_after: Option<RecoverAfter>

Fail the first N requests then recover (circuit-breaker style).

primary: Option<bool>

Mark this response as the primary action of a composite expectation.

extra: Extra

Forward-compatibility catch-all for response fields the typed model does not yet name.

Implementations

impl HttpResponse

pub fn new() -> Self

Create a new empty response.

pub fn status_code(self, code: 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 body(self, body: impl Into<String>) -> Self

Set the response body as a string.

pub fn delay(self, delay: Delay) -> Self

Set a response delay.

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

Add a response cookie (single value per name).

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

Set the HTTP reason phrase (e.g. "Not Found").

pub fn status_code_range(self, range: impl Into<String>) -> Self

Set a status-code range to respond with a random status from (e.g. "2xx").

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

Add a response trailer (HTTP/2 trailing header), multiple values per key.

pub fn generate_from_schema(self, schema: impl Into<String>) -> Self

Generate the response body from a schema string.

pub fn connection_options(self, options: ConnectionOptions) -> Self

Set connection-level options.

pub fn recover_after(self, recover_after: RecoverAfter) -> Self

Set a recover-after (fail-first-N) policy.

pub fn primary(self, primary: bool) -> Self

Mark this response as the primary action of a composite expectation.

Trait Implementations

impl Clone for HttpResponse

fn clone(&self) -> HttpResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpResponse

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

Formats the value using the given formatter.

impl Default for HttpResponse

fn default() -> HttpResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HttpResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for HttpResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HttpResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HttpResponse