swift-bridge

swift-bridge 促进Rust和Swift的互操作性。

swift-bridge 使Rust和Swift之间传递和共享高级类型变得简单，例如 String、Option<T>、Result<T, E>、struct、class 以及更多。

它还帮助您连接高级语言功能，如异步函数和泛型。

使用 swift-bridge 应该比手动管理Rust和Swift FFI更安全、性能更高、更直观。

安装

# In your Cargo.toml

[build-dependencies]
swift-bridge-build = "0.1"

[dependencies]
swift-bridge = "0.1"

书籍

您可以在《swift-bridge 书籍》中找到有关如何一起使用Rust和Swift的信息。

快速预览

您可以通过声明要导入和导出的类型和函数，并在“桥接模块”中用宏注解该模块来使用 swift-bridge。注解使用宏 #[swift_bridge::bridge]。

然后在构建时，您可以使用 swift-bridge-build API 或 swift-bridge-cli CLI 解析您注解的桥接模块，并生成 FFI 层的 Swift 和 C 部分。

以下是如何使用桥接模块描述 Swift 和 Rust 之间 FFI 边界的快速概述。

// We use the `swift_bridge::bridge` macro to declare a bridge module.
// Then at build time the `swift-bridge-build` crate is used to generate
// the corresponding Swift and C FFI glue code.
#[swift_bridge::bridge]
mod ffi {
    // Create "transparent" structs where both Rust and Swift can directly access the fields.
    struct AppConfig {
        file_manager: CustomFileManager,
    }

    // Transparent enums are also supported.
    enum UserLookup {
        ById(UserId),
        ByName(String),
    }

    // Export opaque Rust types, functions and methods for Swift to use.
    extern "Rust" {
        type RustApp;

        #[swift_bridge(init)]
        fn new(config: AppConfig) -> RustApp;
        
        fn get_user(&self, lookup: UserLookup) -> Option<&User>;
    }

    extern "Rust" {
        type User;
        type MessageBoard;

        #[swift_bridge(get(&nickname))]
        fn informal_name(self: &User) -> &str;
    }

    // Import opaque Swift classes and functions for Rust to use.
    extern "Swift" {
        type CustomFileManager;
        fn save_file(&self, name: &str, contents: &[u8]);
    }
}

struct User {
    nickname: String
}

快速入门

swift-bridge 仓库包含一些 示例应用程序，您可以快速尝试库功能，或作为您自己的 Swift + Rust 应用程序的起点。

例如，以下是本地运行 codegen-visualizer 示例项目的方法。

git clone https://github.com/chinedufn/swift-bridge
cd swift-bridge/examples/codegen-visualizer

open CodegenVisualizer/CodegenVisualizer.xcodeproj
# *** Click the "Run" button at the top left of Xcode ***

您可以在《swift-bridge 书籍》中找到有关如何一起使用Rust和Swift的信息。

内置类型

除了允许您在 Rust 和 Swift 之间共享自定义结构体、枚举和类之外，swift-bridge 还支持一系列 Rust 和 Swift 标准库类型。

性能

swift-bridge 旨在在性能关键环境中发挥作用。

它生成的 FFI 代码不使用对象序列化、克隆、同步或其他任何形式的不必要开销。

要测试

运行测试套件。

# Clone the repository
git clone [email protected]:chinedufn/swift-bridge.git
cd swift-bridge

# Run tests
cargo test --all && ./test-swift-rust-integration.sh && ./test-swift-packages.sh 

贡献

如果您想为 swift-bridge 贡献，请查看 贡献者指南。

熟悉贡献流程后，尝试查看一些 优秀的入门问题，看看是否有任何问题引起您的兴趣。

这些问题附带逐步说明，可以帮助您走向实现第一个补丁的方向。

致谢

• cxx 启发了使用桥接模块描述 FFI 边界的想法。

许可

许可协议为 MIT 或 Apache-2.0。