Module pact_matching::models[−][src]

The models module provides all the structures required to model a Pact.

Modules

content_types	Module for handling content types
generators	`generators` module includes all the classes to deal with V3 format generators
http_utils	Module for fetching documents via HTTP
json_utils	Collection of utilities for working with JSON
matchingrules	`matchingrules` module includes all the classes to deal with V3 format matchers
message	The `message` module provides all functionality to deal with messages.
message_pact	The `message_pact` module defines a Pact that contains Messages instead of Interactions.
provider_states	`provider_states` module contains all the logic for dealing with provider states. See https://docs.pact.io/getting_started/provider_states for more info on provider states.
v4	V4 specification models
xml_utils	Collection of utilities for working with XML

Consumer	Struct that defines the consumer of the pact.
PactConflict	Struct that defined an interaction conflict
Provider	Struct that defines a provider of a pact.
Request	Struct that defines the request.
RequestResponseInteraction	Struct that defines an interaction (request and response pair)
RequestResponsePact	Struct that represents a pact between the consumer and provider of a service.
Response	Struct that defines the response.

DifferenceType	Enumeration of the types of differences between requests and responses
OptionalBody	Enum that defines the four main states that a body of a request and response can be in a pact file.
PactSpecification	Enum defining the pact specification versions supported by the library

Version of the library

HttpPart	Trait to specify an HTTP part of a message. It encapsulates the shared parts of a request and response.
Interaction	Interaction Trait
Pact	Trait for a Pact (request/response or message)
ReadWritePact	Trait for objects that can represent Pacts and can be read and written

build_query_string	Converts a query string map into a query string
http_interaction_from_json	Converts the JSON struct into an HTTP Interaction
load_pact_from_json	Loads a Pact model from a JSON Value
load_pact_from_url	Reads the pact file from a URL and parses the resulting JSON into a `Pact` struct
message_interaction_from_json	Converts the JSON struct into a Message Interaction
parse_query_string	Parses a query string into an optional map. The query parameter name will be mapped to a list of values. Where the query parameter is repeated, the order of the values will be preserved.
read_pact	Reads the pact file and parses the resulting JSON into a `Pact` struct
read_pact_from_file	Reads the pact from the file and parses the resulting JSON into a `Pact` struct
write_pact	Writes the pact out to the provided path. If there is an existing pact at the path, the two pacts will be merged together unless overwrite is true. Returns an error if the file can not be written or the pacts can not be merged.