rust_icu：ICU 库的底层 Rust 语言绑定

项目	描述
测试
源代码	https://github.com/google/rust_icu
README	https://github.com/google/rust_icu/blob/main/README.md
覆盖率	查看报告
文档	https://docs.rs/crate/rust_icu

这是一个为 C（即 ICU4C）版本的 Unicode 国际组件（ICU）库提供的底层本地 Rust 语言绑定的库。

如果您只需要快速了解如何下载和安装，请参阅 快速入门指南

有关 ICU 库的详细信息，请参阅 ICU 项目主页。库源代码可以在 Github 上查看。

此文件的最新版本可在 https://github.com/google/rust_icu 上找到。

这不是一个官方支持的产品。

为什么要封装 ICU（而不是做其他事情）？

• Rust 语言的 国际化 页面确认，Rust 中的 ICU 支持不完整，因此拥有一个功能性的封装有助于推进技术进步。

• 例如，Fuchsia 这样的项目已经依赖 ICU，而 Rust 绑定提供了一个简单的方法来使用 Unicode 算法，而无需承担更多依赖。

• 与ICU4X等项目在接口上的合作可能会允许未来无缝过渡到全Rust实现。

仓库结构

该仓库按rust crates的cargo工作空间组织。每个crate对应于ICU4C库C API中的相应头文件。请参阅覆盖率报告以获取头文件中函数覆盖的详细信息。

限制

今天生成的 Rust 语言绑定方法限制了语言绑定对可用 C API 的可用性。ICU 库的 C API（在文档中有时称为 ICU4C）与 ICU C++ API 不同。

此库提供的绑定应用范围有限，这意味着它可能有时不能直接使用。如果您遇到这种情况，请随时提交错误给我们修复。拉取请求欢迎。

我们目前知道的限制如下

• 没有保证的特性一致性。 一些在 C++ 中实现的算法没有 C 等效算法，反之亦然。如果您使用 C++ 库，这通常不会成为问题，因为您可以选择哪个 API 表面适合您。但对于 Rust 绑定来说，这是一个问题，因为我们目前只能使用 C API。

• 新的算法的 C++ 实现不一定总是反映在 C API 中，导致 C 和 C++ API 表面之间的功能差异。例如，参见 此错误。

• 尽管使用 icu_config 功能可能允许您为您的库版本自动生成绑定，但我们仍然需要保留一个明确支持 ICU 版本列表，以确保包装器的稳定性。

兼容性

兼容性保证如下

1. 对所有感兴趣的功能组合，自动测试了最后三个主要 ICU 库版本。
2. 对 docs.rs 系统使用的 ICU 库版本执行了自动测试（因此可以构建文档）。

功能

rust_icu 库旨在使用 cargo 编译，并启用以下功能之一。使用 cargo 编译允许我们在 rust_icu_sys 库的自定义 build.rs 文件中进行库检测，并适应您的构建环境。然而，由于并非每个开发环境都会使用相同的设置，我们选择提供以下功能（以下）作为配置选项。

虽然我们的意图是使以下功能列表与 实际列表 保持更新，但列表可能偶尔会过时。

要使用任何功能，您需要在您打算使用的所有 rust_icu_* 软件包中激活功能。不这样做会导致编译结果混乱。

先决条件

必需

• rust_icu 源代码

  使用 git 克隆

  git clone https://github.com/google/rust_icu.git
  

• rustup

  从 https://rustup.rs 安装。用于设置工具链默认值。这将安装 cargo。

• Clang

  您必须安装 Clang 以访问正确的头文件。

• ICU 库开发环境

  您将需要访问 ICU 库以将 rust_icu 绑定链接到 ICU。ICU 的下载和安装超出了本文档的范围。请阅读ICU 简介，了解如何构建和安装。

  有时，ICU 库可能已经预安装在您的系统上，或者您可以从包管理程序中获取库。然而，这个库不一定是你需要链接到正在开发的程序中的库。简而言之，您有责任在系统上的某个地方备有 ICU 的开发者版本。

  我们有一个快速入门安装，这可能使您在环境配置与我们非常相似的情况下顺利进行，并且您希望从源代码构建 ICU。

可选

• GNU Make，如果您想使用基于 make 的构建和测试。

  安装 GNU Make 超出了本文档的范围。请参阅您操作系统的安装说明。

• docker，如果您决定使用基于 docker 的构建和测试。

  安装 docker 超出了本文档的范围，请参阅docker 安装说明以获取详细信息。由于安装 docker 会干扰主机机器，您的公司可能有关于如何正确安装 docker 的内部文档。

• icu-config 工具，如果使用 icu_config 功能。

  您需要在系统上安装 ICU 库，使得二进制 icu-config 在您的 $PATH 中某处。构建脚本将使用它来发现库设置并生成正确的链接脚本。如果您使用此功能但未找到 icu-config，

• 如果使用 bindgen 功能，将使用 bindgen 工具。

  有关如何安装的说明，请参阅bindgen 用户指南。

• 如果使用 bindgen 功能，将使用 rustfmt 工具。

  有关如何安装的说明，请参阅https://github.com/rust-lang/rustfmt。

测试

运行 rust_icu 的测试有几个选项。

Cargo

使用 cargo 构建 和 测试是构建 和 测试 Rust 代码的规范方式。

在 rust_icu 库的情况下，您可能会发现您系统的默认 ICU 开发包非常陈旧，在这种情况下，您将需要构建自己的 ICU4C 库（下面有说明）。这将使您需要传递环境变量 PKG_CONFIG_PATH 和 LD_LIBRARY_PATH 来帮助构建代码定位和使用您构建的库，而不是系统默认的库。

以下测试都应该能成功构建并通过。请注意，由于所需的库位于自定义位置，我们需要在运行测试时设置 LD_LIBRARY_PATH，以及 PKG_CONFIG_PATH。

如果您发现您可以使用您系统的默认 ICU 安装，则可以安全地省略这两个库。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
        bash -c 'cargo test'

如果您认为上述方法过于麻烦，请考虑尝试基于 Docker 的方法。

GNU Make

如果您喜欢 GNU 的做事方式，您可能会喜欢 GNU Make 方法。

最简单的方法是使用 GNU Make 并运行

make test

如果您在处理 rust_icu，已设置好开发环境，并希望有一个简短的命令来运行测试，您可能会想使用这种方法。

基于 Docker

请参阅上方的可选依赖项部分。

要运行对 rust_icu 源代码的隔离构建和测试，请发出以下命令

make docker-test

这将在您的本地机器上运行基于 Docker 的源代码构建和测试。这是一种测试您的代码是否与特定的 ICU 参考版本兼容的好方法。

现有技术

已经考虑了很多现有技术

• https://github.com/servo/rust-icu
• https://github.com/open-i18n/rust-unic
• https://github.com/fullcontact/icu-sys
• https://github.com/rust-locale
• https://github.com/unicode-rs

目前的情况是，我想先自己做一些实验，然后看看这项工作是否可以合并到上述任何一项工作中。

另请参阅

• https://github.com/rust-lang/rfcs/issues/797
• https://unicode-rs.github.io
• https://github.com/i18n-concept/rust-discuss

假设

对于 ICU 绑定有几种竞争方法。然而，至少根据rust 的 RFC 存储库中的信息，在 Rust 中支持 ICU 的工作似乎仍在进行中。

以下是在创建此库时所做的假设

• 我们需要一个完整、可重用且无痛苦的低级 ICU 库，用于 Rust。

  例如，这意味着我们必须依赖外部 ICU 库，而不是将库本身与绑定代码一起携带。这种模块化允许库的最终用户使用他们选择的 ICU 库，并将其纳入他们各自的系统中。

• 本库的工作不会重新实现任何 ICU 算法。

  ICU 重新实现可能需要数千名工程师年才能完成。对于像 ICU 这样微妙且复杂的 API，我认为维护单个中央实现可能是一个更好的投资回报。

  此外，这个库的存在并不会阻止重新实现。如果有人想尝试重新实现 ICU，这也是可以的。

• 此库应作为 Rust 实现的低级基础。

  低级 ICU API 可能不适合最终用户。应在这些绑定之上构建一个 Rustful API。可能将功能细分为 crate，以符合 Rust 开发者的期望是个不错的主意。

  我很乐意重复使用上述项目中已经做出的某些逻辑划分。

• 我想探讨与现有实现结合以构建 Rust 完整 ICU 支持的方法。

  希望可以将今天可用的所有 Rust 绑定的优点结合到一个统一的 Rust 库中。我随时可以讨论选项。

  我开始独立工作的唯一原因，而不是向“先有艺术”部分中列出的任何项目贡献，是因为我想尝试看看在 Rust 中生成的库会是什么样子。

附加说明

快速入门指南

在开始之前，请确保满足以下先决条件

• 您已安装 docker 并在您的系统上运行。
• 您有 GNU Make。
• 您有 git。
• 您有足够的磁盘空间。构建环境的 Docker 镜像有点大，因此需要几个 GiB 来容纳它们。
• 您有互联网连接。

从那里开始，以下命令序列将检出、构建和测试 rust_icu 源代码。

mkdir -p ~/tmp
cd tmp
git clone https://github.com/google/rust_icu
cd rust_icu
make docker-test

现在您可以对代码和测试进行更改。您可以通过运行 make docker-test 重新运行编译和测试循环。

ICU 安装说明

以下说明遵循 ICU 仓库 中的“树外”构建说明。

假设

以下说明不是自包含的。它们假设

• 您已将系统设置为可以有效地遵循 ICU 构建说明。这需要一些前期时间投资。
• 您可以从源代码构建 ICU，并且您的项目可以访问 ICU 源代码。
• 您的设置是 Linux，有一些非常具体的设置对我来说是有效的。您可能能够根据您的情况进行修改。

编译

mkdir -p $HOME/local
mkdir -p $HOME/tmp
cd $HOME/tmp
git clone https://github.com/unicode-org/icu.git
mkdir icu4c-build
cd icu4c-build
../icu/icu4c/source/runConfigureICU Linux \
  --prefix=$HOME/local \
  --enable-static
make
make install
make doc

如果编译成功完成，目录 $HOME/local/bin 将包含文件 icu-config，这是发现库配置所必需的。

您还可以

make check

运行单元测试。

如果将 $HOME/local/bin 添加到 $PATH，或将 icu-config 移动到您的 $PATH 中列出的目录，您应该可以编译 rust_icu。

ICU 重建说明

如果您打算从源代码重新构建 ICU 库而更改 ICU 库的配置，您可能需要添加一个中间的 make clean 命令。

由于 ICU 构建不是密封的，这确保构建目录中没有旧编译过程的残留物。例如，如果您升级 ICU 库的主要版本，您需要这样做。如果您忘记这样做，您在编译 ICU、链接或运行程序时可能会遇到意外的错误。

为 ICU 的某个版本编译

假设

• 您已选择功能集 [renaming,icu_version_in_env]

或者:

• 您已手动验证，您想要使用的 ICU 版本和功能集在 兼容性矩阵 中有 "是"。

以下是一个测试示例。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
    RUST_ICU_MAJOR_VERSION_NUMBER=65 \
        bash -c 'cargo test'

以下是一个尚未 测试 的示例，即针对预存在的 ICU 版本 66 编译 rust_icu。

env PKG_CONFIG_PATH="$HOME/local/lib/pkgconfig" \
    LD_LIBRARY_PATH="$HOME/local/lib" \
    RUST_ICU_MAJOR_VERSION_NUMBER=66 \
        bash -c 'cargo test'

添加对 ICU 新版本的支持。

一般来说，只要支持 icu-config 方法，就应能够为 ICU 库的新版本生成库包装器，前提是底层的 C API 没有太大差异。

为 ICU 65.1 提供简单支持的方法包括以下步骤。下面，$RUST_ICU_SOURCE_DIR 是您提取 ICU 源代码的目录。

• 将新版本的 ICU 从源代码下载到 $RUST_ICU_SOURCE_DIR。
• 使用新版本构建 ICU 库，例如按照上面的 编译 步骤。
• 从输出目录 $RUST_ICU_SOURCE_DIR/target/debug/build/rust_icu_sys-... 获取文件 lib.rs，将其重命名为 lib_66.rs（如果使用 ICU 版本 66，否则追加您正在使用的版本）。
• 将文件保存到目录 $RUST_ICU_SOURCE_DIR/rust_icu_sys/bindgen，这是包含预生成的源文件的目录。

如果 build.rs 被更改以包含更多功能，则可能需要重新生成这些文件 lib_XX.rs。

添加更多绑定

当添加更多 ICU 包装器时，请确保执行以下操作

• 检查 rust_icu_sys/build.rs 和 rust_icu_sys/bindgen/run_bindgen.sh，然后将适当的行添加到 BINDGEN_SOURCE_MODULES，然后是 BINDGEN_ALLOWLIST_FUNCTIONS 和 BINDGEN_ALLOWLIST_TYPES。

开启特定功能集进行测试

以下是在 ICU 67 上运行 docker 测试的示例，开启 icu_version_in_env 和 renaming 功能，而不是默认设置。请注意，参数主要是通过环境变量传递到运行 docker-test 的容器中。

make DOCKER_TEST_ENV=rust_icu_testenv-67 \
  RUST_ICU_MAJOR_VERSION_NUMBER=67 \
  DOCKER_TEST_CARGO_TEST_ARGS='--no-default-features --features icu_version_in_env,renaming' \
  docker-test

一些说明

• 环境变量 RUST_ICU_MAJOR_VERSION_NUMBER 用于功能 icu_version_in_env，以指导 cargo 使用文件 rust_icu_sys/bindgen/lib_67.rs 作为预构建的 bindgen 源文件，而不是尝试动态生成一个。
• 环境变量 DOCKER_TEST_CARGO_TEST_ARGS 用于将命令行参数传递给 Docker 容器中使用的 cargo test。环境变量以原始形式传递给 cargo test，无需引号，因此环境变量中的单词将成为 cargo test 的单独参数。
• 环境变量 DOCKER_TEST_ENV 是用于运行测试的 Docker 容器的基名。容器 rust_icu_testenv-67 是一个包含预安装 ICU 67 编译版本的容器镜像。

刷新静态 bindgen 文件

需要 docker。

定期运行 make static-bindgen，以刷新位于目录 rust_icu_sys/bindgen 中的静态生成的 bindgen 文件（命名为 lib_XX.rs，其中 XX 是 ICU 版本，例如 67），在关闭 bindgen 功能时使用。

调用此 make 目标将修改带有较新版本的本地签出文件 lib_XX.rs。提交拉取请求并检查它们。

有关为何需要此信息的更多信息，请参阅 bindgen README.md。