Pact Matching FFI [DEPRECATED]
NOTE: This library is being moved into a single FFI library pact_ffi.
This crate provides a Foreign Function Interface (FFI) to the pact_matching
crate,
with the intent of enabling Pact's core matching mechanisms to be used by implementations
in other languages.
Dependencies
This crates requires:
cbindgen
, a tool for automatically generating the header file needed for C users of the crate.- A nightly-channel version of Cargo (needed for an unstable flag used by
cbindgen
to get the macro-expanded contents of the crate source).
It will additionally attempt to find and use Doxygen
to generate C-friendly documentation (you can of course alternatively use cargo doc
to get Rustdoc documentation).
Note: Linking to the generated static library on Linux requires you to also link to pthread
, dl
and m
.
Building
For convenience, this tool integrates with CMake, which is setup to:
- Run Cargo to build the library file.
- Run Cbindgen to build the header file.
- Run Doxygen to build the documentation.
To use this CMake build, you can do the following:
You can also optionally install the built artifacts as follows:
>
)
Examples
This project also includes example uses which depend on the crate via CMake.
Before building an example, make sure to run the following from the overall CMake build
directory (./build
):
Then, from the example's directory, do the following:
Architecture
You can read about the architecture and design choices of this crate in ARCHITECTURE.md.