Struct pact_models::v4::http_parts::HttpResponse

pub struct HttpResponse {
    pub status: u16,
    pub headers: Option<HashMap<String, Vec<String>>>,
    pub body: OptionalBody,
    pub matching_rules: MatchingRules,
    pub generators: Generators,
}

Struct that defines the HTTP response.

Fields

status: u16

Response status

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

Response headers

body: OptionalBody

Response body

matching_rules: MatchingRules

Response matching rules

generators: Generators

Response generators

Implementations

impl HttpResponse

pub fn from_json(response: &Value) -> Result<Self>

Build an HttpResponse from a JSON Value struct.

pub fn to_json(&self) -> Value

Converts this response to a Value struct.

pub fn as_v3_response(&self) -> Response

Converts this response to a v3 response struct

pub fn content_type(&self) -> Option<ContentType>

Determine the content type of the response. Returns the content type of the body, otherwise if a Content-Type header is present, the value of that header will be returned. Otherwise, the body will be inspected.

pub fn is_success(&self) -> bool

If this response represents a success (status code < 400)

pub fn set_header<H: Into<String> + Clone>(&mut self, name: H, value: &[H])

Sets a header value. This will replace any existing header value. This will do a case-insensitive search. Note that the original case of the header will be retained. For example:

use pact_models::v4::http_parts::HttpResponse;
let mut response = HttpResponse::default();
response.set_header("x-test", &["value"]);
response.set_header("X-Test", &["value2"]);
// Header will now be "x-test: value2"

Trait Implementations

impl Clone for HttpResponse

fn clone(&self) -> HttpResponse

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Display for HttpResponse

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

Formats the value using the given formatter.

impl Hash for HttpResponse

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HttpPart for HttpResponse

fn headers(&self) -> &Option<HashMap<String, Vec<String>>>

Returns the headers of the HTTP part.

fn headers_mut(&mut self) -> &mut HashMap<String, Vec<String>>

Returns the headers of the HTTP part in a mutable form.

fn body(&self) -> &OptionalBody

Returns the body of the HTTP part.

fn body_mut(&mut self) -> &mut OptionalBody

Returns a mutable pointer to the body of the HTTP part.

fn matching_rules(&self) -> &MatchingRules

Returns the matching rules of the HTTP part.

fn matching_rules_mut(&mut self) -> &mut MatchingRules

Returns the matching rules of the HTTP part.

fn generators(&self) -> &Generators

Returns the generators of the HTTP part.

fn generators_mut(&mut self) -> &mut Generators

Returns the generators of the HTTP part.

fn lookup_content_type(&self) -> Option<String>

Lookup up the content type for the part

fn detect_content_type(&self) -> Option<ContentType>

Tries to detect the content type of the body by matching some regular expressions against the first 32 characters.

fn content_type(&self) -> Option<ContentType>

Determine the content type of the HTTP part. If a Content-Type header is present, the value of that header will be returned. Otherwise, the body will be inspected.

fn has_header(&self, header_name: &str) -> bool

Checks if the HTTP Part has the given header

fn lookup_header_value(&self, header_name: &str) -> Option<String>

Checks if the HTTP Part has the given header

fn has_text_body(&self) -> bool

If the body is a textual type (non-binary)

fn add_header(&mut self, key: &str, val: Vec<&str>)

Convenience method to add a header

fn build_generators( &self, category: &GeneratorCategory ) -> HashMap<DocPath, Generator>

Builds a map of generators from the generators and matching rules

impl PartialEq for HttpResponse

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for HttpResponse