#[non_exhaustive]pub struct CommentProcessor;Expand description
Callbacks to fix up some comments pulled from the C documentation.
Implementations§
Trait Implementations§
Source§impl Clone for CommentProcessor
impl Clone for CommentProcessor
impl Copy for CommentProcessor
Source§impl Debug for CommentProcessor
impl Debug for CommentProcessor
Source§impl Default for CommentProcessor
impl Default for CommentProcessor
Source§impl ParseCallbacks for CommentProcessor
impl ParseCallbacks for CommentProcessor
Source§fn will_parse_macro(&self, _name: &str) -> MacroParsingBehavior
fn will_parse_macro(&self, _name: &str) -> MacroParsingBehavior
This function will be run on every macro that is identified.
Source§fn generated_name_override(&self, _item_info: ItemInfo<'_>) -> Option<String>
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.
Source§fn generated_link_name_override(
&self,
_item_info: ItemInfo<'_>,
) -> Option<String>
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.
Source§fn int_macro(&self, _name: &str, _value: i64) -> Option<IntKind>
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.Source§fn str_macro(&self, _name: &str, _value: &[u8])
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.
Source§fn func_macro(&self, _name: &str, _value: &[&[u8]])
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. Read more
Source§fn enum_variant_behavior(
&self,
_enum_name: Option<&str>,
_original_variant_name: &str,
_variant_value: EnumVariantValue,
) -> Option<EnumVariantCustomBehavior>
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.
Source§fn enum_variant_name(
&self,
_enum_name: Option<&str>,
_original_variant_name: &str,
_variant_value: EnumVariantValue,
) -> Option<String>
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.Source§fn item_name(&self, _item_info: ItemInfo<'_>) -> Option<String>
fn item_name(&self, _item_info: ItemInfo<'_>) -> Option<String>
Allows to rename an item, replacing
_item_info.name.Source§fn header_file(&self, _filename: &str)
fn header_file(&self, _filename: &str)
This will be called on every header filename passed to
Builder::header.Source§fn include_file(&self, _filename: &str)
fn include_file(&self, _filename: &str)
This will be called on every file inclusion, with the full path of the included file.
Source§fn read_env_var(&self, _key: &str)
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.Source§fn blocklisted_type_implements_trait(
&self,
_name: &str,
_derive_trait: DeriveTrait,
) -> Option<CanDerive>
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. Read more
Source§fn add_derives(&self, _info: &DeriveInfo<'_>) -> Vec<String>
fn add_derives(&self, _info: &DeriveInfo<'_>) -> Vec<String>
Provide a list of custom derive attributes. Read more
Source§fn add_attributes(&self, _info: &AttributeInfo<'_>) -> Vec<String>
fn add_attributes(&self, _info: &AttributeInfo<'_>) -> Vec<String>
Provide a list of custom attributes. Read more
Source§fn field_attributes(&self, _info: &FieldAttributeInfo<'_>) -> Vec<String>
fn field_attributes(&self, _info: &FieldAttributeInfo<'_>) -> Vec<String>
Provide a list of custom attributes for struct/union fields. Read more
Source§fn field_visibility(&self, _info: FieldInfo<'_>) -> Option<FieldVisibilityKind>
fn field_visibility(&self, _info: FieldInfo<'_>) -> Option<FieldVisibilityKind>
Potentially override the visibility of a composite type field. Read more
Source§fn field_name(&self, _info: FieldInfo<'_>) -> Option<String>
fn field_name(&self, _info: FieldInfo<'_>) -> Option<String>
Allows to rename a struct or union field, replacing
_info.field_name.Source§fn new_item_found(
&self,
_id: DiscoveredItemId,
_item: DiscoveredItem,
_source_location: Option<&SourceLocation>,
)
fn new_item_found( &self, _id: DiscoveredItemId, _item: DiscoveredItem, _source_location: Option<&SourceLocation>, )
This will get called everytime an item (currently struct, union, and alias) is found with some information about it
Auto Trait Implementations§
impl Forget for CommentProcessor
impl Freeze for CommentProcessor
impl Move for CommentProcessor
impl RefUnwindSafe for CommentProcessor
impl Send for CommentProcessor
impl Sync for CommentProcessor
impl Unpin for CommentProcessor
impl UnsafeUnpin for CommentProcessor
impl UnwindSafe for CommentProcessor
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more