Enum Typedef

pub enum Typedef<'tu, 'ge> {
    Clang {
        entity: Entity<'tu>,
        gen_env: &'ge GeneratorEnv<'tu>,
    },
    Desc(Rc<TypedefDesc<'tu, 'ge>>),
}

Variants

Clang

Fields

entity: Entity<'tu>

gen_env: &'ge GeneratorEnv<'tu>

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

Implementations

impl<'tu, 'ge> Typedef<'tu, 'ge>

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

Create a corresponding type from EntityKind::TypedefDecl or EntityKind::TypeAliasDecl.

Sometimes the actual type is not a TypeDef, but a Class for example in case of:

typedef struct
{
  int x, y, w, h;
  float score;
} Box;

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

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

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

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

Trait Implementations

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Typedef<'_, '_>

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

Formats the value using the given formatter.

impl Element for Typedef<'_, '_>

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 PartialEq for Typedef<'_, '_>

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

fn rust_module(&self) -> SupportedModule

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

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

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

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

The very last concrete part of the name in Rust

impl RustNativeGeneratedElement for Typedef<'_, '_>

fn element_safe_id(&self) -> String

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

fn element_order(&self) -> u8

Element order in the output file, lower means earlier

fn gen_rust_externs(&self) -> String

fn gen_cpp(&self) -> String