Lib.rs

Interoptopus 🐙

您库的多语言绑定生成器。

在 Rust 中编写健壮的库，轻松从您第二喜欢的语言访问它

• 在 Rust 中设计单个 .dll / .so，从任何地方消耗它。
• 在具有这些特性的语言中获得 QoL 特性（例如，类、字符串）。
• 始终有一个理智的、与 C 兼容的 API。
• 无痛苦的工作流程，无需外部工具。
• 易于支持更多语言，后端完全与主项目解耦。

我们努力使生成的绑定 无成本。它们应该与您自己合理编写的代码一样地道，但绝对不是魔法或隐藏您真正想要公开的接口。

您编写的代码...

use interoptopus::{ffi_function, ffi_type, Inventory, InventoryBuilder, function};

#[ffi_type]
#[repr(C)]
pub struct Vec2 {
    pub x: f32,
    pub y: f32,
}

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

// Define our FFI interface as `ffi_inventory` containing
// a single function `my_function`. Types are inferred.
pub fn ffi_inventory() -> Inventory {
    InventoryBuilder::new()
        .register(function!(my_function))
        .inventory()
}

... Interoptopus 生成的

¹ 对于 参考项目。
² 只需几小时即可添加对新语言的支持。无需拉取请求。 粉红誓言。

入门 🍼

如果您想...

• 创建一个新的 API，请查看 hello world，
• 了解可能的功能，请查看 参考项目，
• 支持新的语言，请 复制 C 后端。

支持的 Rust 构造

请参阅参考项目以获取概述。

• 函数（代码函数和外发代理函数）
• 类型（复合类型、枚举、不可见类型、引用等）
• 常量（原始常量；const评估的结果）
• 模式（ASCII指针、选项、切片、类等）

性能 🏁

生成的底层绑定与该语言的定制绑定相比无任何成本。

尽管如此，即使是定制的绑定在FFI边界也会遇到一些特定于目标的额外开销（例如，在托管语言中的打包或固定）。对于C#，这个成本通常是纳秒级，对于Python CFFI，可能是微秒级。

虽然最终您对语言的FFI性能无能为力，但了解调用成本可以帮助您设计更好的API。

详细的调用成本表可在此处找到：^🔥

• C#调用开销
• Python调用开销

为了快速概述，此表列出了最常见的调用类型，单位为纳秒/调用

特性标志

位于derive之后，这些功能启用

• derive - 诸如ffi_type之类的进程宏...
• serde - 内部类型上的Serde属性。
• log - 在FFI错误上调用log。

变更日志

• v0.14 - 更好的库存用户体验。
• v0.13 - Python后端现在使用ctypes。
• v0.12 - 使用#[ffi_service_method]提高了兼容性。
• v0.11 - C#将构造函数切换为静态方法。
• v0.10 - C#风味DotNet和Unity（包括Burst）。
• v0.9 - C#切片速度提高150倍，Python类型提示。
• v0.8 - 将测试函数移动到各自的后端。
• v0.7 - 将模式进程宏制作成更好的FFI文档。
• v0.6 - 重命名并澄清了许多模式。
• v0.5 - 在Rust和FFI中更好地使用切片。
• v0.4 - 在自动生成的FFI调用中启用日志支持。
• v0.3 - 提高泛型的兼容性。
• v0.2 - 引入了“模式”；C#的工作互操作。
• v0.1 - 第一个版本。

另外，请参阅我们的升级说明。

常见问题解答

• 常见问题解答和安全指南.

贡献

欢迎PR。

• 直接提交小的错误修复。重大更改应首先作为问题提出。
• 任何使先前正常工作的绑定更改行为或停止编译的事情都是重大更改；
• 这并不意味着我们反对破坏东西，只是我们希望在它发生之前讨论它。
• 新功能或模式必须在参考项目中实现，并至少在一个包含的后端中附带一个互操作测试（即，一个后端测试，它运行C# / Python针对调用该代码的DLL）。