Struct GeneratorEnv

pub struct GeneratorEnv<'tu> {
    pub settings: Settings,
    /* private fields */
}

Generator environment or context, contains a global data (passed by immutable reference) for the binding generation

This is partially pre-populated in an additional pass before the generation to provide some necessary data that’s not available at the generation moment. E.g. list of descendants of a particular class.

Fields

settings: Settings

Implementations

impl<'tu> GeneratorEnv<'tu>

pub fn empty() -> Self

pub fn global(module: SupportedModule, root_entity: Entity<'tu>) -> Self

GeneratorEnv with the global settings for the regular working mode

pub fn make_export_config(&mut self, entity: Entity<'_>) -> &mut ExportConfig

pub fn get_export_config(&self, entity: Entity<'_>) -> Option<ExportConfig>

pub fn make_rename_config(&mut self, entity: Entity<'_>) -> &mut RenameConfig

pub fn get_rename_config(&self, entity: Entity<'_>) -> Option<&RenameConfig>

pub fn get_func_comment(&self, line: u32, cpp_refname: &str) -> Option<&str>

pub fn get_class_kind(&self, entity: Entity<'tu>) -> Option<ClassKind>

Calculates the [ClassKind] of the class entity based on the macros connected to its declaration and whether it can be expressed as simple in Rust

pub fn descendants_of(&self, cpp_refname: &str) -> Option<&HashSet<Entity<'tu>>>

Returns the descendants of the specified class

Trait Implementations

impl Debug for GeneratorEnv<'_>

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

Formats the value using the given formatter.