Struct pact_models::v4::http_parts::HttpRequest

pub struct HttpRequest {
    pub method: String,
    pub path: String,
    pub query: Option<HashMap<String, Vec<String>>>,
    pub headers: Option<HashMap<String, Vec<String>>>,
    pub body: OptionalBody,
    pub matching_rules: MatchingRules,
    pub generators: Generators,
}

Struct that defines the HTTP request.

Fields

method: String

Request method

path: String

Request path

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

Request query string

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

Request headers

body: OptionalBody

Request body

matching_rules: MatchingRules

Request matching rules

generators: Generators

Request generators

Implementations

impl HttpRequest

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

Builds a HttpRequest from a JSON Value struct.

pub fn to_json(&self) -> Value

Converts this HttpRequest to a Value struct.

pub fn as_v3_request(&self) -> Request

Convert this request to a V3 request struct

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

Determine the content type of the request. 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.

Trait Implementations

impl Clone for HttpRequest

fn clone(&self) -> HttpRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HttpRequest

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

Formats the value using the given formatter.

impl Default for HttpRequest

fn default() -> Self

Returns the “default value” for a type.

impl Display for HttpRequest

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

Formats the value using the given formatter.

impl Hash for HttpRequest

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, 

Feeds a slice of this type into the given Hasher.

impl HttpPart for HttpRequest

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 matching_rules(&self) -> &MatchingRules

Returns the matching rules of the HTTP part.

fn generators(&self) -> &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<HttpRequest> for HttpRequest

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 !=.

impl Eq for HttpRequest

impl StructuralEq for HttpRequest