Struct bindgen::BindgenOptions
[−]
[src]
pub struct BindgenOptions {
pub hidden_types: RegexSet,
pub opaque_types: RegexSet,
pub whitelisted_types: RegexSet,
pub whitelisted_functions: RegexSet,
pub whitelisted_vars: RegexSet,
pub bitfield_enums: RegexSet,
pub constified_enums: RegexSet,
pub builtins: bool,
pub links: Vec<(String, LinkType)>,
pub emit_ast: bool,
pub emit_ir: bool,
pub emit_ir_graphviz: Option<String>,
pub enable_cxx_namespaces: bool,
pub disable_name_namespacing: bool,
pub layout_tests: bool,
pub derive_debug: bool,
pub derive_default: bool,
pub unstable_rust: bool,
pub use_core: bool,
pub ctypes_prefix: Option<String>,
pub namespaced_constants: bool,
pub msvc_mangling: bool,
pub convert_floats: bool,
pub raw_lines: Vec<String>,
pub clang_args: Vec<String>,
pub input_header: Option<String>,
pub input_unsaved_files: Vec<UnsavedFile>,
pub dummy_uses: Option<String>,
pub parse_callbacks: Option<Box<ParseCallbacks>>,
pub codegen_config: CodegenConfig,
pub conservative_inline_namespaces: bool,
pub generate_comments: bool,
pub generate_inline_functions: bool,
pub whitelist_recursively: bool,
pub objc_extern_crate: bool,
pub enable_mangling: bool,
pub prepend_enum_name: bool,
}Configuration options for generated bindings.
Deprecated: use a Builder instead.
Fields
The set of types that have been blacklisted and should not appear anywhere in the generated code.
opaque_types: RegexSet
The set of types that should be treated as opaque structures in the generated code.
whitelisted_types: RegexSet
The set of types that we should have bindings for in the generated code.
This includes all types transitively reachable from any type in this set. One might think of whitelisted types/vars/functions as GC roots, and the generated Rust code as including everything that gets marked.
whitelisted_functions: RegexSet
Whitelisted functions. See docs for whitelisted_types for more.
whitelisted_vars: RegexSet
Whitelisted variables. See docs for whitelisted_types for more.
bitfield_enums: RegexSet
The enum patterns to mark an enum as bitfield.
constified_enums: RegexSet
The enum patterns to mark an enum as constant.
builtins: bool
Whether we should generate builtins or not.
links: Vec<(String, LinkType)>
The set of libraries we should link in the generated Rust code.
emit_ast: bool
True if we should dump the Clang AST for debugging purposes.
emit_ir: bool
True if we should dump our internal IR for debugging purposes.
emit_ir_graphviz: Option<String>
Output graphviz dot file.
enable_cxx_namespaces: bool
True if we should emulate C++ namespaces with Rust modules in the generated bindings.
disable_name_namespacing: bool
True if we should avoid mangling names with namespaces.
layout_tests: bool
True if we should generate layout tests for generated structures.
derive_debug: bool
True if we should derive Debug trait implementations for C/C++ structures and types.
derive_default: bool
True if we should derive Default trait implementations for C/C++ structures and types.
unstable_rust: bool
True if we can use unstable Rust code in the bindings, false if we cannot.
use_core: bool
True if we should avoid using libstd to use libcore instead.
ctypes_prefix: Option<String>
An optional prefix for the "raw" types, like c_int, c_void...
namespaced_constants: bool
True if we should generate constant names that are directly under namespaces.
msvc_mangling: bool
True if we should use MSVC name mangling rules.
convert_floats: bool
Whether we should convert float types to f32/f64 types.
raw_lines: Vec<String>
The set of raw lines to prepend to the generated Rust code.
clang_args: Vec<String>
The set of arguments to pass straight through to Clang.
input_header: Option<String>
The input header file.
input_unsaved_files: Vec<UnsavedFile>
Unsaved files for input.
dummy_uses: Option<String>
Generate a dummy C/C++ file that includes the header and has dummy uses
of all types defined therein. See the uses module for more.
parse_callbacks: Option<Box<ParseCallbacks>>
A user-provided visitor to allow customizing different kinds of situations.
codegen_config: CodegenConfig
Which kind of items should we generate? By default, we'll generate all of them.
conservative_inline_namespaces: bool
Whether to treat inline namespaces conservatively.
See the builder method description for more details.
generate_comments: bool
Wether to keep documentation comments in the generated output. See the documentation for more details.
generate_inline_functions: bool
Whether to generate inline functions. Defaults to false.
whitelist_recursively: bool
Wether to whitelist types recursively. Defaults to true.
objc_extern_crate: bool
Intead of emitting 'use objc;' to files generated from objective c files, generate '#[macro_use] extern crate objc;'
enable_mangling: bool
Whether to use the clang-provided name mangling. This is true 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.
prepend_enum_name: bool
Whether to prepend the enum name to bitfield or constant variants.
Trait Implementations
impl Debug for BindgenOptions[src]
impl UnwindSafe for BindgenOptions[src]
TODO(emilio): This is sort of a lie (see the error message that results from removing this), but since we don't share references across panic boundaries it's ok.
impl Default for BindgenOptions[src]
fn default() -> BindgenOptions
Returns the "default value" for a type. Read more