Struct opencv_binding_generator::Generator

source ·
pub struct Generator { /* private fields */ }
Expand description

Main workhorse for generating OpenCV bindings for a specific module

Full binding generation for a module is happening in the following major phases:

  1. Headers are parsed with libclang
  2. [crate::generator_env::GeneratorEnvPopulator] collects the data necessary in the binding generation (1st pass)
  3. Binding entities are extracted using the data from step 2 (2nd pass)
  4. Specific source files are generated by crate::writer::RustNativeBindingWriter (at the moment)

Implementations§

source§

impl Generator

source

pub fn new( opencv_include_dir: &Path, additional_include_dirs: &[&Path], src_cpp_dir: &Path ) -> Self

source

pub fn is_clang_loaded(&self) -> bool

source

pub fn clang_version(&self) -> String

source

pub fn build_clang_command_line_args(&self) -> Vec<Cow<'static, str>>

source

pub fn pre_process( &self, module: &str, panic_on_error: bool, entity_processor: impl FnOnce(Entity<'_>) )

Runs the clang header parsing, check for the compilation errors and hands off to entity_processor

source

pub fn generate(&self, module: &str, visitor: impl GeneratorVisitor)

Runs the full binding generation process using the supplied visitor

Trait Implementations§

source§

impl Debug for Generator

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.