Enum Class

pub enum Class<'tu, 'ge> {
    Clang {
        entity: Entity<'tu>,
        custom_fullname: Option<Rc<str>>,
        gen_env: &'ge GeneratorEnv<'tu>,
    },
    Desc(Rc<ClassDesc<'tu, 'ge>>),
}

Variants

Clang

Fields

entity: Entity<'tu>

custom_fullname: Option<Rc<str>>

gen_env: &'ge GeneratorEnv<'tu>

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

Implementations

impl<'tu, 'ge> Class<'tu, 'ge>

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

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

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

pub fn can_be_simple(&self) -> bool

Checks whether a class can be simple on Rust side, i.e. represented by plain struct with fields

pub fn kind(&self) -> ClassKind

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

pub fn string_type(&self) -> Option<StrType>

Returns Some with the string type if the current class name refers to a C++ std::string or cv::String

pub fn template_kind(&self) -> TemplateKind<'tu, 'ge>

pub fn is_abstract(&self) -> bool

pub fn is_polymorphic(&self) -> bool

True if a class has virtual methods

pub fn as_enum(&self) -> Option<Enum<'tu>>

Special case of an empty class with only an anonymous enum inside (e.g., DrawLinesMatchesFlags)

pub fn has_explicit_clone(&self) -> bool

Class has an explicit method named clone()

pub fn has_implicit_clone(&self) -> bool

Class is simple (i.e. constructor-copiable in C++), but can’t be simple in Rust

pub fn has_implicit_default_constructor(&self) -> bool

pub fn has_virtual_destructor(&self) -> bool

pub fn has_private_destructor(&self) -> bool

pub fn has_bases(&self) -> bool

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

pub fn all_bases(&self) -> HashSet<Class<'tu, 'ge>>

pub fn has_descendants(&self) -> bool

pub fn descendants(&self) -> HashSet<Class<'tu, 'ge>>

pub fn all_descendants(&self) -> HashSet<Class<'tu, 'ge>>

pub fn all_family(&self) -> HashSet<Class<'tu, 'ge>>

pub fn has_methods(&self) -> bool

pub fn for_each_method( &self, predicate: impl FnMut(Func<'tu, 'ge>) -> ControlFlow<()>, ) -> ControlFlow<()>

pub fn methods( &self, filter: impl Fn(&Func<'_, '_>) -> bool, ) -> Vec<Func<'tu, 'ge>>

pub fn has_fields(&self) -> bool

pub fn for_each_field( &self, predicate: impl FnMut(Field<'tu, 'ge>) -> ControlFlow<()>, ) -> ControlFlow<()>

pub fn fields( &self, filter: impl Fn(&Field<'_, '_>) -> bool, ) -> Vec<Field<'tu, 'ge>>

pub fn for_each_const( &self, predicate: impl FnMut(Const<'tu>) -> ControlFlow<()>, ) -> ControlFlow<()>

pub fn consts(&self) -> Vec<Const<'tu>>

pub fn field_methods<'f>( &self, fields: &'f [Field<'tu, 'ge>], constness_filter: Option<Constness>, ) -> impl Iterator<Item = Func<'tu, 'ge>> + 'f

pub fn is_definition(&self) -> bool

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

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Class<'_, '_>

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

Formats the value using the given formatter.

impl Element for Class<'_, '_>

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 Hash for Class<'_, '_>

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

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 Class<'_, '_>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RustElement for Class<'_, '_>

fn rust_module(&self) -> SupportedModule

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

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

The very last concrete part of the name in Rust

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

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

impl RustNativeGeneratedElement for Class<'_, '_>

fn element_safe_id(&self) -> String

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

fn gen_rust_externs(&self) -> String

fn gen_cpp(&self) -> String

fn element_order(&self) -> u8

Element order in the output file, lower means earlier

impl Eq for Class<'_, '_>