Enum opencv_binding_generator::Func

pub enum Func<'tu, 'ge> {
    Clang {
        entity: Entity<'tu>,
        custom_rust_leafname: Option<Rc<str>>,
        gen_env: &'ge GeneratorEnv<'tu>,
    },
    Desc(Rc<FuncDesc<'tu, 'ge>>),
}

Variants

Clang

Fields

entity: Entity<'tu>

custom_rust_leafname: Option<Rc<str>>

gen_env: &'ge GeneratorEnv<'tu>

Desc(Rc<FuncDesc<'tu, 'ge>>)

Implementations

impl<'tu, 'ge> Func<'tu, 'ge>

pub fn new(entity: Entity<'tu>, gen_env: &'ge GeneratorEnv<'tu>) -> Self

pub fn new_ext( entity: Entity<'tu>, custom_rust_leafname: Option<Rc<str>>, gen_env: &'ge GeneratorEnv<'tu> ) -> Self

pub fn new_desc(desc: FuncDesc<'tu, 'ge>) -> Self

pub fn set_custom_rust_leafname( &mut self, custom_rust_leafname: Option<Rc<str>> )

Sets custom rust_leafname for this func, used to disambiguate function names

pub fn custom_rust_leafname(&self) -> Option<&str>

pub fn specialize( self, spec: &'static HashMap<&'static str, TypeRefFactory> ) -> Self

pub fn is_specialized(&self) -> bool

pub fn kind(&self) -> Cow<'_, FuncKind<'tu, 'ge>>

pub fn constness(&self) -> Constness

pub fn is_abstract(&self) -> bool

pub fn is_generic(&self) -> bool

pub fn return_kind(&self) -> ReturnKind

pub fn safety(&self) -> Safety

pub fn is_default_constructor(&self) -> bool

pub fn is_clone(&self) -> bool

pub fn is_no_discard(&self) -> bool

pub fn return_type_ref(&self) -> TypeRef<'tu, 'ge>

pub fn has_arguments(&self) -> bool

pub fn num_arguments(&self) -> usize

pub fn arguments(&self) -> Cow<'_, [Field<'tu, 'ge>]>

pub fn generated_types(&self) -> Vec<GeneratedType<'tu, 'ge>>

pub fn identifier(&self) -> String

pub fn func_id(&self) -> FuncId<'_>

pub fn cpp_body(&self) -> &FuncCppBody

pub fn cpp_call_invoke(&self) -> String

pub fn cpp_return( &self, ret: &str, ret_cast: Option<Cow<'_, str>>, ocv_ret_name: &str ) -> Cow<'static, str>

Trait Implementations

impl<'tu, 'ge> Clone for Func<'tu, 'ge>

fn clone(&self) -> Func<'tu, 'ge>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Func<'_, '_>

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

Formats the value using the given formatter.

impl Element for Func<'_, '_>

fn exclude_kind(&self) -> ExcludeKind

fn is_system(&self) -> bool

fn is_public(&self) -> bool

fn doc_comment(&self) -> Cow<'_, str>

fn cpp_namespace(&self) -> Cow<'_, str>

fn cpp_name(&self, style: CppNameStyle) -> Cow<'_, str>

fn update_debug_struct<'dref, 'a, 'b>( &self, struct_debug: &'dref mut DebugStruct<'a, 'b> ) -> &'dref mut DebugStruct<'a, 'b>

impl RustElement for Func<'_, '_>

fn rust_module(&self) -> Cow<'_, str>

fn rust_name(&self, style: NameStyle) -> Cow<'_, str>

fn rust_leafname(&self, _fish_style: FishStyle) -> Cow<'_, str>

fn rendered_doc_comment_with_prefix( &self, prefix: &str, opencv_version: &str ) -> String

fn rust_module_reference(&self) -> Cow<'_, str>

fn rendered_doc_comment(&self, opencv_version: &str) -> String

impl RustNativeGeneratedElement for Func<'_, '_>

fn element_safe_id(&self) -> String

fn gen_rust(&self, opencv_version: &str) -> String

fn gen_rust_exports(&self) -> String

fn gen_cpp(&self) -> String

fn element_order(&self) -> u8

Element order in the output file, lower means earlier