# Pact Mock Server library
This library implements the in-process mock server for matching HTTP requests and generating responses from a pact file.
It implements the [V3 Pact specification](https://github.com/pact-foundation/pact-specification/tree/version-3).
[Online rust docs](https://docs.rs/pact_mock_server/)
For an example of calling these functions, have a [look at the JavaScript reference](https://github.com/pact-foundation/pact-reference/blob/master/javascript/README.md).
All the exported functions using C bindings for controlling the mock server are now found in the [pact_mock_server_ffi module](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_mock_server_ffi).
## [create_mock_server](http://www.pact.io/reference/rust/libpact_mock_server-docs-latest/pact_mock_server/fn.create_mock_server.html)
External interface to create a mock server. A pointer to the pact JSON as a C string is passed in,
as well as the port for the mock server to run on. A value of 0 for the port will result in a
port being allocated by the operating system. The port of the mock server is returned.
## [mock_server_matched](http://www.pact.io/reference/rust/libpact_mock_server-docs-latest/pact_mock_server/fn.mock_server_matched.html)
Simple function that returns a boolean value given the port number of the mock service. This value will be true if all
the expectations of the pact that the mock server was created with have been met. It will return false if any request did
not match, an un-recognised request was received or an expected request was not received.
## [mock_server_mismatches](http://www.pact.io/reference/rust/libpact_mock_server-docs-latest/pact_mock_server/fn.mock_server_mismatches.html)
This returns all the mismatches, un-expected requests and missing requests in JSON format, given the port number of the
mock server.
**IMPORTANT NOTE:** The JSON string for the result is allocated on the rust heap, and will have to be freed once the
code using the mock server is complete. The `cleanup_mock_server` function is provided for this purpose. If the mock
server is not cleaned up properly, this will result in memory leaks as the rust heap will not be reclaimed.
## [cleanup_mock_server](http://www.pact.io/reference/rust/libpact_mock_server-docs-latest/pact_mock_server/fn.cleanup_mock_server.html)
This function will try terminate the mock server with the given port number and cleanup any memory allocated for it by
the `mock_server_mismatches` function. Returns `true`, unless a mock server with the given port number does not exist,
or the function fails in some way.
**NOTE:** Although `close()` on the listerner for the mock server is called, this does not currently work and the
listerner will continue handling requests. In this case, it will always return a 501 once the mock server has been
cleaned up.
## [write_pact_file](http://www.pact.io/reference/rust/libpact_mock_server-docs-latest/pact_mock_server/fn.write_pact_file.html)
External interface to trigger a mock server to write out its pact file. This function should
be called if all the consumer tests have passed. The directory to write the file to is passed
as the second parameter. If a NULL pointer is passed, the current working directory is used.
Returns 0 if the pact file was successfully written. Returns a positive code if the file can
not be written, or there is no mock server running on that port or the function panics.