Struct interoptopus::Inventory

pub struct Inventory { /* private fields */ }

Represents all FFI-relevant items, produced via InventoryBuilder, ingested by backends.

Implementations

impl Inventory

pub fn functions(&self) -> &[Function]

Return all functions registered.

pub fn ctypes(&self) -> &[CType]

Returns all found types; this includes types directly used in fields and parameters, and all their recursive constitutents.

pub fn constants(&self) -> &[Constant]

Return all registered constants.

pub fn namespaces(&self) -> &[String]

Return all known namespaces.

pub fn patterns(&self) -> &[LibraryPattern]

Return all registered LibraryPattern. In contrast, TypePattern will be found inside the types returned via ctypes().

pub fn filter<P: FnMut(InventoryItem<'_>) -> bool>( &self, predicate: P ) -> Inventory

Return a new Inventory filtering items by a predicate.

Useful for removing duplicate symbols when generating bindings split across multiple files.

Examples

Here we filter an inventory, keeping only types, removing all other items.

let filtered = inventory.filter(|x| {
    match x {
        InventoryItem::CType(_) => true,
        _ => false,
    }
});

Trait Implementations

impl Clone for Inventory

fn clone(&self) -> Inventory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Inventory

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

Formats the value using the given formatter.

impl Default for Inventory

fn default() -> Inventory

Returns the “default value” for a type.

impl From<Inventory> for APIVersion

fn from(i: Inventory) -> Self

Converts to this type from the input type.

impl PartialEq for Inventory

fn eq(&self, other: &Inventory) -> 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 Inventory

fn partial_cmp(&self, other: &Inventory) -> 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 StructuralPartialEq for Inventory