Lib.rs

Interoptopus 🐙

The polyglot bindings generator for your library.

Write a robust library in Rust, easily access it from your second-favorite language:

• Design a single .dll / .so in Rust, consume it from anywhere.
• Get QoL features (e.g., classes, strings) in languages that have them.
• Painless workflow, no external tooling required.
• Easy to support more languages, backends fully decoupled from main project.

We strive to make our generated bindings zero cost. They should be as idiomatic as you could have reasonably written them yourself, but never magic or hiding the interface you actually wanted to expose.

Code you write ...

#[ffi_type]
pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

#[ffi_function]
pub fn my_function(input: Vec2) {
    println!("{}", input.x);
}

// List functions you want to export, types are inferred.
pub fn ffi_inventory() -> Inventory {
    InventoryBuilder::new()
        .register(function!(my_function))
        .validate()
        .build()
}

... Interoptopus generates

^✅ Tier 1 target. Active maintenance and production use. Full support of all features.
^⏯️ Tier 2 target. Might be missing features or UX, contributors wanted!
¹ For the reference project.
² Add basic support for a new language in just a few hours. No pull request needed.

Getting Started 🍼

If you want to ...

• get started see the hello world,
• productify your project, see the real project layout,
• understand what's possible, see the reference project,
• support a new language, copy the C backend.

Supported Rust Constructs

See the reference project for an overview:

• functions (freestanding functions and delegates)
• types (composites, enums, opaques, references, ...)
• constants (primitive constants; results of const evaluation)
• patterns (ASCII pointers, options, slices, ...)
• services (turn to classes in C# and Python, and async methods)

Performance 🏁

Generated low-level bindings are zero cost w.r.t. hand-crafted bindings for that language.

That said, even hand-crafted bindings encounter some target-specific overhead at the FFI boundary (e.g., marshalling, pinning, and safety checks). For C# that cost is often nanoseconds, for Python it can be microseconds.

Detailed call cost tables can be found here: ^🔥

• C# call overhead
• Python call overhead

For a quick overview, this table lists some common round trip times in ns / call:

¹ First time delegate creation and pinning is expensive in C# (100's of ns). We recommend you retain the delegate instead for >20x faster calls, see for example here.
² Preliminary numbers for full round trip to tokio and back. Although async calls have some intrinsic overhead (e.g., spawning a new TaskCompletionSource is ~100ns), some of that overhead appears to be a benchmarking effect when spin-waiting for a newly spawned task. In essence, if your application benefits from async this overhead is negligible, but simple getters or setters shouldn't needlessly be made async.

Feature Flags

Gated behind feature flags, these enable:

• derive - Proc macros such as ffi_type, ...
• serde - Serde attributes on internal types.
• log - Invoke log on FFI errors.

Changelog

• v0.15 - Massive cleanup, bugfix, UX overhaul (+syn2).
• v0.14 - Better inventory UX.
• v0.13 - Python backend uses ctypes now.

Also see our upgrade instructions.

FAQ

• FAQ and Safety Guides.

Contributing

PRs are very welcome!

• Submit small bug fixes directly. Major changes should be issues first.
• New features or patterns must be materialized in the reference project and accompanied by at least an C# interop test.