Module interoptopus::lang::c

Canonical, almost-C representation of items in an FFI boundary.

The types in here are the crate::Inventory building blocks with which a C API can be built. In addition, they contain a few extra, non-C elements (e.g., namespaces, patterns), all of which however can reasonably be mapped to or ignored in C.

Except for special circumstances (e.g., when implementing CTypeInfo for a type you don’t own; or when writing your own backend) you will not need any of the items in this module. In most cases the types here are automatically generated by an attribute; and later consumed by a backend.

Structs

• ArrayType
  A (C-style) type[N] containing a fixed number of elements of the same type.
• CompositeType
  Used for Rust and C struct with named fields, must be #[repr(C)].
• Constant
  A Rust const definition with a name and value, might become a #define.
• Documentation
  Markdown generated from the /// you put on Rust code.
• EnumType
  A (C-style) enum containing numbered variants.
• Field
  Fields of a CompositeType.
• FnPointerType
  Represents extern "C" fn() types in Rust and (*f)(). in C.
• Function
  A named, exported #[no_mangle] extern "C" fn f() function.
• FunctionSignature
  Represents multiple in and a single out parameters.
• Meta
  Additional information for user-defined types.
• OpaqueType
  A named struct that becomes a fieldless typedef struct S S; in C.
• Parameter
  Parameters of a FunctionSignature.
• Variant
  Variant and value of a EnumType.

Enums

• CType
  A type that can exist at the FFI boundary.
• ConstantValue
  The value of a constant.
• PrimitiveType
  A primitive type that natively exists in C and is FFI safe.
• PrimitiveValue
  A primitive value expressible on C-level.
• Visibility
  Doesn’t exist in C, but other languages can benefit from accidentally using ‘private’ fields.