Struct pact_models::request::Request

pub struct Request {
    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 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 Request

pub fn from_json(
    request_json: &Value,
    spec_version: &PactSpecification
) -> Result<Request>

Builds a Request from a Value struct.

pub fn to_json(&self, spec_version: &PactSpecification) -> Value

Converts this Request to a Value struct.

pub fn default_request() -> Request

👎 Deprecated since 0.6.0:

please use default() from the standard Default trait instead

Returns the default request: a GET request to the root.

pub fn differences_from(&self, other: &Request) -> Vec<(DifferenceType, String)>

Return a description of all the differences from the other request

pub fn as_v4_request(&self) -> HttpRequest

Convert this interaction to V4 format

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Self

Returns the “default value” for a type.

impl Display for Request

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

Formats the value using the given formatter.

impl Hash for Request

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 Request

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<Request> for Request

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: &Self) -> bool

This method tests for !=.

impl Eq for Request

impl StructuralEq for Request