Struct CargoCallbacks

pub struct CargoCallbacks { /* private fields */ }

A ParseCallbacks implementation that will act on file includes by echoing a rerun-if-changed line and on env variable usage by echoing a rerun-if-env-changed line

When running inside a build.rs script, this can be used to make cargo invalidate the generated bindings whenever any of the files included from the header change:

use bindgen::builder;
let bindings = builder()
    .header("path/to/input/header")
    .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
    .generate();

Implementations

impl CargoCallbacks

pub fn new() -> CargoCallbacks

Create a new CargoCallbacks value.

pub fn rerun_on_header_files(self, doit: bool) -> CargoCallbacks

Whether Cargo should re-run the build script if any of the input header files has changed.

This option is enabled by default unless the deprecated CargoCallbacks constructor is used.

Trait Implementations

impl Debug for CargoCallbacks

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for CargoCallbacks

fn default() -> CargoCallbacks

Returns the “default value” for a type.

impl ParseCallbacks for CargoCallbacks

fn header_file(&self, filename: &str)

This will be called on every header filename passed to (Builder::header)crate::Builder::header.

fn include_file(&self, filename: &str)

This will be called on every file inclusion, with the full path of the included file.

fn read_env_var(&self, key: &str)

This will be called every time bindgen reads an environment variable whether it has any content or not.

fn will_parse_macro(&self, _name: &str) -> MacroParsingBehavior

This function will be run on every macro that is identified.

fn generated_name_override(&self, _item_info: ItemInfo<'_>) -> Option<String>

This function will run for every extern variable and function. The returned value determines the name visible in the bindings.

fn generated_link_name_override( &self, _item_info: ItemInfo<'_>, ) -> Option<String>

This function will run for every extern variable and function. The returned value determines the link name in the bindings.

fn int_macro(&self, _name: &str, _value: i64) -> Option<IntKind>

The integer kind an integer macro should have, given a name and the value of that macro, or None if you want the default to be chosen.

fn str_macro(&self, _name: &str, _value: &[u8])

This will be run on every string macro. The callback cannot influence the further treatment of the macro, but may use the value to generate additional code or configuration.

fn func_macro(&self, _name: &str, _value: &[&[u8]])

This will be run on every function-like macro. The callback cannot influence the further treatment of the macro, but may use the value to generate additional code or configuration.

fn enum_variant_behavior( &self, _enum_name: Option<&str>, _original_variant_name: &str, _variant_value: EnumVariantValue, ) -> Option<EnumVariantCustomBehavior>

This function should return whether, given an enum variant name, and value, this enum variant will forcibly be a constant.

fn enum_variant_name( &self, _enum_name: Option<&str>, _original_variant_name: &str, _variant_value: EnumVariantValue, ) -> Option<String>

Allows to rename an enum variant, replacing _original_variant_name.

fn item_name(&self, _original_item_name: &str) -> Option<String>

Allows to rename an item, replacing _original_item_name.

fn blocklisted_type_implements_trait( &self, _name: &str, _derive_trait: DeriveTrait, ) -> Option<CanDerive>

This will be called to determine whether a particular blocklisted type implements a trait or not. This will be used to implement traits on other types containing the blocklisted type.

fn add_derives(&self, _info: &DeriveInfo<'_>) -> Vec<String>

Provide a list of custom derive attributes.

fn add_attributes(&self, _info: &AttributeInfo<'_>) -> Vec<String>

Provide a list of custom attributes.

fn process_comment(&self, _comment: &str) -> Option<String>

Process a source code comment.

fn field_visibility(&self, _info: FieldInfo<'_>) -> Option<FieldVisibilityKind>

Potentially override the visibility of a composite type field.

fn new_item_found(&self, _id: DiscoveredItemId, _item: DiscoveredItem)

This will get called everytime an item (currently struct, union, and alias) is found with some information about it