Struct Type

pub struct Type<'tu> { /* private fields */ }

The type of an AST entity.

Implementations

impl<'tu> Type<'tu>

pub fn get_kind(&self) -> TypeKind

Returns the kind of this type.

pub fn get_display_name(&self) -> String

Returns the display name of this type.

pub fn get_alignof(&self) -> Result<usize, AlignofError>

Returns the alignment of this type in bytes.

Failures

• this type is a dependent type
• this type is an incomplete type

pub fn get_offsetof<F: AsRef<str>>( &self, field: F, ) -> Result<usize, OffsetofError>

Returns the offset of the field with the supplied name in this record type in bits.

Failures

• this record type is a dependent type
• this record record type is an incomplete type
• this record type does not contain a field with the supplied name

Examples found in repository

examples/structs.rs (line 28)

fn main() {
    // Acquire an instance of `Clang`
    let clang = Clang::new().unwrap();

    // Create a new `Index`
    let index = Index::new(&clang, false, false);

    // Parse a source file into a translation unit
    let tu = index.parser("examples/structs.c").parse().unwrap();

    // Get the structs in this translation unit
    let structs = tu.get_entity().get_children().into_iter().filter(|e| {
        e.get_kind() == EntityKind::StructDecl
    }).collect::<Vec<_>>();

    // Print information about the structs
    for struct_ in structs {
        let type_ =  struct_.get_type().unwrap();
        let size = type_.get_sizeof().unwrap();
        println!("struct: {:?} (size: {} bytes)", struct_.get_name().unwrap(), size);

        for field in struct_.get_children() {
            let name = field.get_name().unwrap();
            let offset = type_.get_offsetof(&name).unwrap();
            println!("    field: {:?} (offset: {} bits)", name, offset);
        }
    }
}

pub fn get_sizeof(&self) -> Result<usize, SizeofError>

Returns the size of this type in bytes.

Failures

• this type is a dependent type
• this type is an incomplete type
• this type is a variable size type

Examples found in repository

examples/structs.rs (line 23)

fn main() {
    // Acquire an instance of `Clang`
    let clang = Clang::new().unwrap();

    // Create a new `Index`
    let index = Index::new(&clang, false, false);

    // Parse a source file into a translation unit
    let tu = index.parser("examples/structs.c").parse().unwrap();

    // Get the structs in this translation unit
    let structs = tu.get_entity().get_children().into_iter().filter(|e| {
        e.get_kind() == EntityKind::StructDecl
    }).collect::<Vec<_>>();

    // Print information about the structs
    for struct_ in structs {
        let type_ =  struct_.get_type().unwrap();
        let size = type_.get_sizeof().unwrap();
        println!("struct: {:?} (size: {} bytes)", struct_.get_name().unwrap(), size);

        for field in struct_.get_children() {
            let name = field.get_name().unwrap();
            let offset = type_.get_offsetof(&name).unwrap();
            println!("    field: {:?} (offset: {} bits)", name, offset);
        }
    }
}

pub fn get_address_space(&self) -> usize

Returns the address space of this type.

pub fn get_argument_types(&self) -> Option<Vec<Type<'tu>>>

Returns the argument types for this function or method type, if applicable.

pub fn get_calling_convention(&self) -> Option<CallingConvention>

Returns the calling convention specified for this function type, if applicable.

pub fn get_canonical_type(&self) -> Type<'tu>

Returns the canonical type for this type.

The canonical type is the underlying type with all “sugar” removed (e.g., typedefs).

pub fn get_class_type(&self) -> Option<Type<'tu>>

Returns the class type for this member pointer type, if applicable.

pub fn get_declaration(&self) -> Option<Entity<'tu>>

Returns the AST entity that declared this type, if any.

pub fn get_elaborated_type(&self) -> Option<Type<'tu>>

Returns the type named by this elaborated type, if applicable.

pub fn get_element_type(&self) -> Option<Type<'tu>>

Returns the element type for this array, complex, or vector type, if applicable.

pub fn get_exception_specification(&self) -> Option<ExceptionSpecification>

Returns the exception specification of this type, if applicable.

pub fn get_fields(&self) -> Option<Vec<Entity<'tu>>>

Returns the fields in this record type, if applicable.

pub fn get_modified_type(&self) -> Option<Type<'tu>>

Return the type that was modified by this attributed type.

pub fn get_nullability(&self) -> Option<Nullability>

Returns the nullability of this pointer type, if applicable.

pub fn get_objc_encoding(&self) -> Option<String>

Returns the encoding of this Objective-C type, if applicable.

pub fn get_objc_object_base_type(&self) -> Option<Type<'_>>

Returns the base type of this Objective-C type, if applicable.

pub fn get_objc_protocol_declarations(&self) -> Vec<Entity<'tu>>

Returns the declarations for all protocol references for this Objective-C type, if applicable.

pub fn get_objc_type_arguments(&self) -> Vec<Type<'tu>>

Returns the type arguments for this Objective-C type, if applicable.

pub fn get_pointee_type(&self) -> Option<Type<'tu>>

Returns the pointee type for this pointer type, if applicable.

pub fn get_ref_qualifier(&self) -> Option<RefQualifier>

Returns the ref qualifier for this C++ function or method type, if applicable.

pub fn get_result_type(&self) -> Option<Type<'tu>>

Returns the result type for this function or method type, if applicable.

pub fn get_size(&self) -> Option<usize>

Returns the size of this constant array or vector type, if applicable.

pub fn get_template_argument_types(&self) -> Option<Vec<Option<Type<'tu>>>>

Returns the template argument types for this template class specialization type, if applicable.

pub fn get_typedef_name(&self) -> Option<String>

Returns the typedef name of this type, if applicable.

pub fn is_const_qualified(&self) -> bool

Returns whether this type is qualified with const.

pub fn is_elaborated(&self) -> Option<bool>

Returns whether this type is an elaborated type, if it can be determined for certain.

pub fn is_pod(&self) -> bool

Returns whether this type is plain old data (POD).

pub fn is_restrict_qualified(&self) -> bool

Returns whether this type is qualified with restrict.

pub fn is_transparent_tag(&self) -> bool

Returns whether this type is a transparent tag typedef.

pub fn is_variadic(&self) -> bool

Returns whether this type is a variadic function type.

pub fn is_volatile_qualified(&self) -> bool

Returns whether this type is qualified with volatile.

pub fn visit_fields<F: FnMut(Entity<'tu>) -> bool>(&self, f: F) -> Option<bool>

Visits the fields in this record type, returning None if this type is not a record type and returning Some(b) otherwise where b indicates whether visitation was ended by the callback returning false.

pub fn is_integer(&self) -> bool

Returns whether this type is an integer type.

pub fn is_signed_integer(&self) -> bool

Returns whether this type is a signed integer type.

pub fn is_unsigned_integer(&self) -> bool

Returns whether this type is an unsigned integer type.

Trait Implementations

impl<'tu> Clone for Type<'tu>

fn clone(&self) -> Type<'tu>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'tu> Debug for Type<'tu>

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

Formats the value using the given formatter.

impl<'tu> PartialEq for Type<'tu>

fn eq(&self, other: &Type<'tu>) -> bool

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

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<'tu> Copy for Type<'tu>

impl<'tu> Eq for Type<'tu>