pcre2-sys

Bindings for PCRE2.

Dual-licensed under MIT or the UNLICENSE.

Documentation

https://docs.rs/pcre2-sys

Usage

Run cargo add pcre2-sys to add this crate to your Cargo.toml file.

Notes

As a -sys crate, this exposes only the bindings to PCRE2 based on the header file. The PCRE2 documentation itself should be consulted in order to use this crate.

The bindings for this crate were generated for PCRE 10.42. This crate intends to track the current release of PCRE2.

The build script for this crate prefers dynamically linking with the host's PCRE2 system library. If that isn't available or if static linking is desired, then PCRE2 is built from source and statically linked.

Static linking will automatically happen for MUSL targets, but can be forced by setting the PCRE2_SYS_STATIC environment variable to 1. Similarly, if PCRE2_SYS_STATIC is set to 0, then static linking will be forcefully disabled, even for MUSL targets.

Currently, this crate only supports libpcre-8 where PCRE2_CODE_UNIT_WIDTH=8.

This crate has been tested to work on Windows, Linux and macOS. Other platforms may work, and PRs to support them are welcome.

If you're compiling this crate on Windows with the GNU toolchain, then you'll need to make sure you have a compatible C compiler installed, such as the one provided by the MinGW-w64 project.

Set the PCRE2_SYS_DEBUG flag to forcefully enable debug symbols when doing a static build, even when compiling in release mode.