Enum interoptopus::lang::c::CType

pub enum CType {
    Primitive(PrimitiveType),
    Array(ArrayType),
    Enum(EnumType),
    Opaque(OpaqueType),
    Composite(CompositeType),
    FnPointer(FnPointerType),
    ReadPointer(Box<CType>),
    ReadWritePointer(Box<CType>),
    Pattern(TypePattern),
}

A type that can exist at the FFI boundary.

Variants

Primitive(PrimitiveType)

Array(ArrayType)

Enum(EnumType)

Opaque(OpaqueType)

Composite(CompositeType)

FnPointer(FnPointerType)

ReadPointer(Box<CType>)

ReadWritePointer(Box<CType>)

Pattern(TypePattern)

Special patterns with primitives existing on C-level but special semantics. useful to higher level languages.

Implementations

impl CType

pub fn size_of(&self) -> usize

pub fn align_of(&self) -> usize

pub const fn void() -> Self

pub fn name_within_lib(&self) -> String

Produces a name unique for that type with respect to this library.

The name here is supposed to uniquely determine a type relative to a library (crate::Inventory), but it is not guaranteed to be C-compatible and may contain special characters (e.g., *const u32).

Backends should instead match on the CType variant and determine a more appropriate name on a case-by-case basis; including changing a name entirely.

pub fn embedded_types(&self) -> Vec<CType>

Lists all other types this type refers to.

pub fn deref_pointer(&self) -> Option<&CType>

If this was a pointer type, tries to deref it and return the inner type.

pub fn as_composite_type(&self) -> Option<&CompositeType>

Convenience method attempting to convert the contained type as a composite.

pub fn as_opaque_type(&self) -> Option<&OpaqueType>

Convenience method attempting to convert the contained type as an opaque.

pub fn is_void(&self) -> bool

Checks if this is a PrimitiveType::Void.

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

Returns the namespace of the type.

Trait Implementations

impl Clone for CType

fn clone(&self) -> CType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CType

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

Formats the value using the given formatter.

impl Default for CType

fn default() -> Self

Returns the “default value” for a type.

impl Hash for CType

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 Ord for CType

fn cmp(&self, other: &CType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CType

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for CType

fn partial_cmp(&self, other: &CType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CType

impl StructuralPartialEq for CType