[][src]Struct bindgen::Builder

pub struct Builder { /* fields omitted */ }

Configure and generate Rust bindings for a C/C++ header.

This is the main entry point to the library.

This example is not tested
use bindgen::builder;

// Configure and generate bindings.
let bindings = builder().header("path/to/input/header")
    .whitelisted_type("SomeCoolClass")
    .whitelisted_function("do_some_cool_thing")
    .generate()?;

// Write the generated bindings to an output file.
bindings.write_to_file("path/to/output.rs")?;

Enums

Bindgen can map C/C++ enums into Rust in different ways. The way bindgen maps enums depends on the pattern passed to several methods:

  1. constified_enum_module()
  2. bitfield_enum()
  3. rustified_enum()

For each C enum, bindgen tries to match the pattern in the following order:

  1. Constified enum module
  2. Bitfield enum
  3. Rustified enum

If none of the above patterns match, then bindgen will generate a set of Rust constants.

Methods

impl Builder
[src]

Generates the command line flags use for creating Builder.

Add an input C/C++ header to generate bindings for.

This can be used to generate bindings to a single header:

This example is not tested
let bindings = bindgen::Builder::default()
    .header("input.h")
    .generate()
    .unwrap();

Or you can invoke it multiple times to generate bindings to multiple headers:

This example is not tested
let bindings = bindgen::Builder::default()
    .header("first.h")
    .header("second.h")
    .header("third.h")
    .generate()
    .unwrap();

Add contents as an input C/C++ header named name.

The file name will be added to the clang arguments.

Specify the rust target

The default is the latest stable Rust version

Disable support for native Rust unions, if supported.

Set the output graphviz file.

Whether the generated bindings should contain documentation comments or not.

This ideally will always be true, but it may need to be false until we implement some processing on comments to work around issues as described in:

https://github.com/rust-lang-nursery/rust-bindgen/issues/426

Whether to whitelist recursively or not. Defaults to true.

Given that we have explicitly whitelisted the "initiate_dance_party" function in this C header:

typedef struct MoonBoots {
    int bouncy_level;
} MoonBoots;

void initiate_dance_party(MoonBoots* boots);

We would normally generate bindings to both the initiate_dance_party function and the MoonBoots struct that it transitively references. By configuring with whitelist_recursively(false), bindgen will not emit bindings for anything except the explicitly whitelisted items, and there would be no emitted struct definition for MoonBoots. However, the initiate_dance_party function would still reference MoonBoots!

Disabling this feature will almost certainly cause bindgen to emit bindings that will not compile! If you disable this feature, then it is your responsibility to provide definitions for every type that is referenced from an explicitly whitelisted item. One way to provide the definitions is by using the Builder::raw_line method, another would be to define them in Rust and then include!(...) the bindings immediately afterwards.

Generate #[macro_use] extern crate objc; instead of use objc; in the prologue of the files generated from objective-c files

Generate proper block signatures instead of void pointers.

Generate #[macro_use] extern crate block; instead of use block; in the prologue of the files generated from apple block files

Whether to use the clang-provided name mangling. This is true by default and probably needed for C++ features.

However, some old libclang versions seem to return incorrect results in some cases for non-mangled functions, see 1, so we allow disabling it.

Deprecated

: Use blacklist_type instead

Hide the given type from the generated bindings. Regular expressions are supported.

Hide the given type from the generated bindings. Regular expressions are supported.

Hide the given function from the generated bindings. Regular expressions are supported.

Hide the given item from the generated bindings, regardless of whether it's a type, function, module, etc. Regular expressions are supported.

Treat the given type as opaque in the generated bindings. Regular expressions are supported.

Deprecated

: use whitelist_type instead

Whitelist the given type so that it (and all types that it transitively refers to) appears in the generated bindings. Regular expressions are supported.

Whitelist the given type so that it (and all types that it transitively refers to) appears in the generated bindings. Regular expressions are supported.

Whitelist the given function so that it (and all types that it transitively refers to) appears in the generated bindings. Regular expressions are supported.

Deprecated

: use whitelist_function instead

Whitelist the given function.

Deprecated: use whitelist_function instead.

Whitelist the given variable so that it (and all types that it transitively refers to) appears in the generated bindings. Regular expressions are supported.

Deprecated

: use whitelist_var instead

Whitelist the given variable.

Deprecated: use whitelist_var instead.

Set the default style of code to generate for enums

Mark the given enum (or set of enums, if using a pattern) as being bitfield-like. Regular expressions are supported.

This makes bindgen generate a type that isn't a rust enum. Regular expressions are supported.

Mark the given enum (or set of enums, if using a pattern) as a Rust enum.

This makes bindgen generate enums instead of constants. Regular expressions are supported.

Use this with caution. You should not be using Rust enums unless you have complete control of the C/C++ code that you're binding to. Take a look at https://github.com/rust-lang/rust/issues/36927 for more information.

Mark the given enum (or set of enums, if using a pattern) as a set of constants that are not to be put into a module.

Mark the given enum (or set of enums, if using a pattern) as a set of constants that should be put into a module.

This makes bindgen generate modules containing constants instead of just constants. Regular expressions are supported.

Add a string to prepend to the generated bindings. The string is passed through without any modification.

Add a given line to the beginning of module mod.

Add a given set of lines to the beginning of module mod.

Add an argument to be passed straight through to clang.

Add arguments to be passed straight through to clang.

Emit bindings for builtin definitions (for example __builtin_va_list) in the generated Rust.

Avoid converting floats to f32/f64 by default.

Set whether layout tests should be generated.

Set whether Debug should be implemented, if it can not be derived automatically.

Set whether PartialEq should be implemented, if it can not be derived automatically.

Set whether Copy should be derived by default.

Set whether Debug should be derived by default.

Set whether Default should be derived by default.

Set whether Hash should be derived by default.

Set whether PartialOrd should be derived by default. If we don't compute partialord, we also cannot compute ord. Set the derive_ord to false when doit is false.

Set whether Ord should be derived by default. We can't compute Ord without computing PartialOrd, so we set the same option to derive_partialord.

Set whether PartialEq should be derived by default.

If we don't derive PartialEq, we also cannot derive Eq, so deriving Eq is also disabled when doit is false.

Set whether Eq should be derived by default.

We can't derive Eq without also deriving PartialEq, so we also enable deriving PartialEq when doit is true.

Set whether or not to time bindgen phases, and print information to stderr.

Emit Clang AST.

Emit IR.

Enable C++ namespaces.

Enable detecting must_use attributes on C functions.

This is quite slow in some cases (see #1465), so it's disabled by default.

Note that for this to do something meaningful for now at least, the rust target version has to have support for #[must_use].

Disable name auto-namespacing.

By default, bindgen mangles names like foo::bar::Baz to look like foo_bar_Baz instead of just Baz.

This method disables that behavior.

Note that this intentionally does not change the names used for whitelisting and blacklisting, which should still be mangled with the namespaces.

Note, also, that this option may cause bindgen to generate duplicate names.

Treat inline namespaces conservatively.

This is tricky, because in C++ is technically legal to override an item defined in an inline namespace:

inline namespace foo {
    using Bar = int;
}
using Bar = long;

Even though referencing Bar is a compiler error.

We want to support this (arguably esoteric) use case, but we don't want to make the rest of bindgen users pay an usability penalty for that.

To support this, we need to keep all the inline namespaces around, but then bindgen usage is a bit more difficult, because you cannot reference, e.g., std::string (you'd need to use the proper inline namespace).

We could complicate a lot of the logic to detect name collisions, and if not detected generate a pub use inline_ns::* or something like that.

That's probably something we can do if we see this option is needed in a lot of cases, to improve it's usability, but my guess is that this is not going to be too useful.

Whether inline functions should be generated or not.

Note that they will usually not work. However you can use -fkeep-inline-functions or -fno-inline-functions if you are responsible of compiling the library to make them callable.

Ignore functions.

Ignore methods.

Deprecated

: please use rust_target instead

Avoid generating any unstable Rust, such as Rust unions, in the generated bindings.

Use core instead of libstd in the generated bindings.

Use the given prefix for the raw types instead of ::std::os::raw.

Allows configuring types in different situations, see the ParseCallbacks documentation.

Choose what to generate using a CodegenConfig.

Prepend the enum name to constant or bitfield variants.

Set whether rustfmt should format the generated bindings.

Set the absolute path to the rustfmt configuration file, if None, the standard rustfmt options are used.

Sets an explicit path to rustfmt, to be used when rustfmt is enabled.

Generate the Rust bindings using the options built up thus far.

Preprocess and dump the input header files to disk.

This is useful when debugging bindgen, using C-Reduce, or when filing issues. The resulting file will be named something like __bindgen.i or __bindgen.ii

Don't derive PartialEq for a given type. Regular expressions are supported.

Don't derive Copy for a given type. Regular expressions are supported.

Don't derive Hash for a given type. Regular expressions are supported.

Trait Implementations

impl Default for Builder
[src]

impl Debug for Builder
[src]

Auto Trait Implementations

impl !Send for Builder

impl !Sync for Builder

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]