Go to file
Emilio Cobos Álvarez 142f62abdf ci: clippy fixes.
The allowed casts are because c_longlong etc aren't guaranteed to map to
i64 / etc. I believe c_double maps to f64 in all platforms tho.
2022-10-16 21:29:41 +02:00
.github ci: clippy fixes. 2022-10-16 21:29:41 +02:00
bindgen ci: clippy fixes. 2022-10-16 21:29:41 +02:00
bindgen-cli Remove no-longer-correct include entry in Cargo.toml. 2022-10-16 21:29:41 +02:00
bindgen-integration split the repo into a workspace 2022-10-04 20:47:17 -05:00
bindgen-tests Remove no-longer-correct include entry in Cargo.toml. 2022-10-16 21:29:41 +02:00
book split the repo into a workspace 2022-10-04 20:47:17 -05:00
ci split the repo into a workspace 2022-10-04 20:47:17 -05:00
csmith-fuzzing Move the csmith-fuzzing directory to the top level. 2022-10-16 21:29:41 +02:00
releases Update Links 2019-05-21 13:41:42 +02:00
.gitattributes Always check out test headers and expectations as LF 2017-09-22 19:02:42 -07:00
.gitignore split the repo into a workspace 2022-10-04 20:47:17 -05:00
appveyor.yml tests: Stop testing libclang 4.0 2022-03-15 03:53:10 +01:00
Cargo.lock split the repo into a workspace 2022-10-04 20:47:17 -05:00
Cargo.toml split the repo into a workspace 2022-10-04 20:47:17 -05:00
CHANGELOG.md Add a few missing changelog entries. 2022-10-16 21:29:41 +02:00
CONTRIBUTING.md update CONTRIBUTING.md 2022-09-26 10:55:05 -05: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 Bump MSRV to 1.57.0 2022-07-18 10:50:15 +02: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.57.0.

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"
  • BINDGEN_EXTRA_CLANG_ARGS_<TARGET>: similar to BINDGEN_EXTRA_CLANG_ARGS, but used to set per-target arguments to pass to clang. Useful to set system include directories in a target-specific way in cross-compilation environments with multiple targets. Has precedence over BINDGEN_EXTRA_CLANG_ARGS.

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!