Struct pact_consumer::builders::ResponseBuilder

pub struct ResponseBuilder { /* private fields */ }

Builder for Response objects. Normally created via PactBuilder.

Implementations

impl ResponseBuilder

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

Set the status code for the response. Defaults to 200.

use pact_consumer::builders::ResponseBuilder;
use pact_consumer::prelude::*;

let response = ResponseBuilder::default().status(404).build();
assert_eq!(response.status, 404);

pub fn ok(&mut self) -> &mut Self

Set the status code to 200 OK. (This is default.)

pub fn created(&mut self) -> &mut Self

Set the status code to 201 Created.

pub fn no_content(&mut self) -> &mut Self

Set the status code to 204 No Content.

pub fn unauthorized(&mut self) -> &mut Self

Set the status code to 401 Unauthorized.

pub fn forbidden(&mut self) -> &mut Self

Set the status code to 403 Forbidden.

pub fn not_found(&mut self) -> &mut Self

Set the status code to 404 Not Found.

pub fn build(&self) -> Response

Build the specified Response object.

pub fn build_v4(&self) -> HttpResponse

Build the specified Response object in V4 format.

pub async fn contents(
    &mut self,
    content_type: ContentType,
    definition: Value
) -> &mut Self

Set the body using the definition. If the body is being supplied by a plugin, this is what is sent to the plugin to setup the body.

Trait Implementations

impl Clone for ResponseBuilder

fn clone(&self) -> ResponseBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseBuilder

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

Formats the value using the given formatter.

impl Default for ResponseBuilder

fn default() -> Self

Returns the “default value” for a type.

impl HttpPartBuilder for ResponseBuilder

fn header<N, V>(&mut self, name: N, value: V) -> &mut Self where
    N: Into<String>,
    V: Into<StringPattern>, 

Specify a header pattern.

fn header_from_provider_state<N, E, V>(
    &mut self,
    name: N,
    expression: E,
    value: V
) -> &mut Self where
    N: Into<String>,
    E: Into<String>,
    V: Into<StringPattern>, 

Specify a header pattern and a generator from provider state.

fn content_type<CT>(&mut self, content_type: CT) -> &mut Self where
    CT: Into<StringPattern>, 

Set the Content-Type header.

fn html(&mut self) -> &mut Self

Set the Content-Type header to text/html.

fn json_utf8(&mut self) -> &mut Self

Set the Content-Type header to application/json; charset=utf-8, with enough flexibility to cover common variations.

fn body<B: Into<String>>(&mut self, body: B) -> &mut Self

Specify a body literal. This does not allow using patterns.

fn body2<B: Into<String>>(&mut self, body: B, content_type: B) -> &mut Self

Specify a body literal with content type. This does not allow using patterns.

fn json_body<B: Into<JsonPattern>>(&mut self, body: B) -> &mut Self

Specify the body as JsonPattern, possibly including special matching rules.