vcpkg-rs 使用教程

vcpkg-rs 使用教程

项目介绍

vcpkg-rs 是一个用于帮助 Cargo 库在 Vcpkg 树中找到库的构建依赖项。Vcpkg 是一个 C++ 库管理工具，而 vcpkg-rs 则将其功能扩展到了 Rust 生态系统中。通过 vcpkg-rs，Rust 开发者可以轻松地集成和使用 Vcpkg 管理的 C++ 库。

项目快速启动

安装

首先，确保你已经安装了 Vcpkg 并进行了全局集成。然后，将 vcpkg-rs 添加到你的 Cargo.toml 文件中：

[build-dependencies]
vcpkg = "0.2.15"

使用示例

在你的 build.rs 文件中，添加以下代码来查找并链接一个库：

extern crate vcpkg;

fn main() {
    vcpkg::find_package("libssh2").unwrap();
}

如果你想自定义输出的 Cargo 元数据，可以使用以下代码：

extern crate vcpkg;

fn main() {
    vcpkg::Config::new()
        .emit_includes(true)
        .find_package("zlib")
        .unwrap();
}

应用案例和最佳实践

静态与动态链接

在 Linux 和 macOS 上，vcpkg-rs 默认使用静态链接。你可以通过设置 VCPKGRS_TRIPLET 环境变量来选择自定义的三元组。

在 Windows 上，默认使用 x64-windows-static-md 配置，这是一个社区支持的配置，适合 Rust。如果你想构建完全静态的二进制文件，可以使用以下命令：

RUSTFLAGS=-Ctarget-feature=+crt-static

环境变量

vcpkg-rs 支持多个环境变量来配置其行为，例如：

• VCPKG_ROOT：设置 Vcpkg 安装目录。
• VCPKGRS_TRIPLET：自定义三元组选择。
• VCPKGRS_NO_FOO：禁用查找名为 foo 的库。
• VCPKGRS_DISABLE：禁用所有库的查找。
• VCPKGRS_DYNAMIC：启用动态链接。

典型生态项目

cargo-vcpkg

cargo-vcpkg 是一个相关的工具，可以从零开始获取和构建 Vcpkg 安装所需的包。它简化了 Vcpkg 的初始设置和包管理过程。

其他生态项目

• Rust-vcpkg-integration：一个用于简化 Rust 和 Vcpkg 集成的项目。
• vcpkg-registry：一个用于管理和共享 Vcpkg 包的注册表项目。

通过这些工具和项目，Rust 开发者可以更高效地使用 Vcpkg 管理的外部库，从而加速开发过程。