Struct interoptopus::InventoryBuilder

pub struct InventoryBuilder { /* private fields */ }

Produces a Inventory inside your inventory function, start here.

Example

Define an inventory function containing a function, constant, and an extra type. This function can be called from your unit tests and the returned Inventory used to create bindings.

use interoptopus::{Inventory, InventoryBuilder, function, constant, extra_type, pattern, ffi_function, ffi_constant, ffi_type};

// First, define some items our DLL uses or needs.

#[ffi_function]
#[no_mangle]
pub extern "C" fn primitive_void() { }

#[ffi_constant]
pub const MY_CONSTANT: u32 = 123;

#[ffi_type]
#[repr(C)]
pub struct ExtraType<T> {
    x: T
}

// Then list all items for which to generate bindings. Call this function
// from another crate or unit test and feed the `Library` into a backend to
// generate bindings for a specific language.
pub fn my_inventory() -> Inventory {
    InventoryBuilder::new()
        .register(function!(primitive_void))
        .register(constant!(MY_CONSTANT))
        .register(extra_type!(ExtraType<f32>))
        .inventory()
}

Implementations

impl InventoryBuilder

pub fn new() -> Self

Start creating a new library.

pub fn register(self, s: Symbol) -> Self

Registers a symbol.

Call this with the result of a function, constant, extra_type or pattern macro, see the example above.

pub fn inventory(self) -> Inventory

Produce the Inventory.

Trait Implementations

impl Debug for InventoryBuilder

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

Formats the value using the given formatter.

impl Default for InventoryBuilder

fn default() -> InventoryBuilder

Returns the “default value” for a type.