Struct pyo3_bindgen::Config

pub struct Config {

    pub traverse_submodules: bool,
    pub generate_preludes: bool,
    pub generate_imports: bool,
    pub generate_classes: bool,
    pub generate_type_vars: bool,
    pub generate_functions: bool,
    pub generate_properties: bool,
    pub generate_docs: bool,
    pub blocklist_names: Vec<String>,
    pub include_private: bool,
    pub generate_dependencies: bool,
    pub suppress_python_stdout: bool,
    pub suppress_python_stderr: bool,
}

Configuration for Codegen engine.

Fields

traverse_submodules: bool

Flag that determines whether to recursively generate code for all submodules of the target modules.

generate_preludes: bool

Flag that determines whether to generate code for prelude modules (Python __all__ attribute).

generate_imports: bool

Flag that determines whether to generate code for imports.

generate_classes: bool

Flag that determines whether to generate code for classes.

generate_type_vars: bool

Flag that determines whether to generate code for type variables.

generate_functions: bool

Flag that determines whether to generate code for functions.

generate_properties: bool

Flag that determines whether to generate code for properties.

generate_docs: bool

Flag that determines whether to documentation for the generate code. The documentation is based on Python docstrings.

blocklist_names: Vec<String>

List of blocklisted attribute names that are skipped during the code generation.

include_private: bool

Flag that determines whether private attributes are considered while parsing the Python code.

generate_dependencies: bool

Flag that determines whether to generate code for all dependencies of the target modules. The list of dependent modules is derived from the imports of the target modules.

Warning: This feature is not fully supported yet.

suppress_python_stdout: bool

Flag that suppresses the generation of Python STDOUT while parsing the Python code.

suppress_python_stderr: bool

Flag that suppresses the generation of Python STDERR while parsing the Python code.

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Create a builder for building Config. On the builder, call .traverse_submodules(...)(optional), .generate_preludes(...)(optional), .generate_imports(...)(optional), .generate_classes(...)(optional), .generate_type_vars(...)(optional), .generate_functions(...)(optional), .generate_properties(...)(optional), .generate_docs(...)(optional), .blocklist_names(...)(optional), .include_private(...)(optional), .generate_dependencies(...)(optional), .suppress_python_stdout(...)(optional), .suppress_python_stderr(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Config.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl Hash for Config

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Config

impl StructuralPartialEq for Config