Go to file
2021-04-03 13:05:04 +02:00
.github Run tests on AArch64 using Debian multiarch and QEMU 2021-02-08 13:29:31 +01:00
bindgen-integration Rename whitelist -> allowlist and blacklist -> blocklist 2021-02-18 17:25:13 +01:00
book From Nullablibility to Nullability 2021-03-29 15:27:20 +02:00
ci Run tests on AArch64 using Debian multiarch and QEMU 2021-02-08 13:29:31 +01:00
csmith-fuzzing Allow grepping bindings for multiple patterns. 2020-08-29 17:11:52 +02:00
releases Update Links 2019-05-21 13:41:42 +02:00
src codegen: Don't use a sym temporary in dynamic library code. 2021-04-03 13:05:04 +02:00
tests codegen: Don't use a sym temporary in dynamic library code. 2021-04-03 13:05:04 +02:00
.gitattributes Always check out test headers and expectations as LF 2017-09-22 19:02:42 -07:00
.gitignore Fix gitignore so ripgrep works 2019-01-25 12:03:22 -05:00
appveyor.yml Add llvm 9.0 to CI. 2019-10-14 14:15:46 +02:00
build.rs Respect changes to BINDGEN_EXTRA_CLANG_ARGS 2020-06-22 11:40:35 +02:00
Cargo.lock Upgrade to shlex 1 2021-02-21 19:30:43 +01:00
Cargo.toml Upgrade to shlex 1 2021-02-21 19:30:43 +01:00
CHANGELOG.md Rename whitelist -> allowlist and blacklist -> blocklist 2021-02-18 17:25:13 +01:00
CONTRIBUTING.md docs: Remove IRC reference. 2021-03-29 14:00:05 +02:00
example-graphviz-ir.png Update the example graphviz image 2017-02-17 17:45:49 -08:00
LICENSE Regenerates the BSD3 License so GitHub recognises it 2018-07-05 14:16:28 +01:00
README.md Document that people can request releases 2020-11-13 20:22:27 +01:00
rustfmt.toml Rustfmt. 2019-09-17 11:53:23 +09:00

crates.io docs.rs

bindgen

bindgen automatically generates Rust FFI bindings to C (and some C++) libraries.

For example, given the C header doggo.h:

typedef struct Doggo {
    int many;
    char wow;
} Doggo;

void eleven_out_of_ten_majestic_af(Doggo* pupper);

bindgen produces Rust FFI code allowing you to call into the doggo library's functions and use its types:

/* automatically generated by rust-bindgen 0.99.9 */

#[repr(C)]
pub struct Doggo {
    pub many: ::std::os::raw::c_int,
    pub wow: ::std::os::raw::c_char,
}

extern "C" {
    pub fn eleven_out_of_ten_majestic_af(pupper: *mut Doggo);
}

Users Guide

📚 Read the bindgen users guide here! 📚

MSRV

The minimum supported Rust version is 1.40.

No MSRV bump policy has been established yet, so MSRV may increase in any release.

API Reference

API reference documentation is on docs.rs

Environment Variables

In addition to the library API and executable command-line API, bindgen can be controlled through environment variables.

End-users should set these environment variables to modify bindgen's behavior without modifying the source code of direct consumers of bindgen.

  • BINDGEN_EXTRA_CLANG_ARGS: extra arguments to pass to clang
    • Arguments are whitespace-separated
    • Use shell-style quoting to pass through whitespace
    • Examples:
      • Specify alternate sysroot: --sysroot=/path/to/sysroot
      • Add include search path with spaces: -I"/path/with spaces"

Additionally, bindgen uses libclang to parse C and C++ header files. To modify how bindgen searches for libclang, see the clang-sys documentation. For more details on how bindgen uses libclang, see the bindgen users guide.

Releases

We don't follow a specific release calendar, but if you need a release please file an issue requesting that (ping @emilio for increased effectiveness).

Contributing

See CONTRIBUTING.md for hacking on bindgen!