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

这是一个针对 Unicode 国际组件 (ICU) 库 C (即 ICU4C) 的低级原生 Rust 语言绑定的库。

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

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

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

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

为什么包装 ICU (而不是做其他任何事情)？

• Rust 语言的 国际化 页面确认，Rust 中的 ICU 支持存在缺陷，因此拥有一个功能性的包装器有助于推进技术的发展。

• 如 Fuchsia 这样的项目已经依赖 ICU，并且 Rust 绑定允许轻松使用 Unicode 算法，而无需承担更多依赖。

• 与如 ICU4X 这样的项目在接口上的合作将允许在未来无缝过渡到全 Rust 实现。

仓库结构

该仓库组织为一个 Rust crate 的 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文件中进行一些库检测，并调整构建过程以适应您的构建环境。但是，由于并非每个开发环境都使用相同的设置，我们选择提供以下功能作为配置选项。

虽然我们的意图是保持以下功能的列表与Cargo.toml中的实际列表保持更新，但列表可能会定期过时。

要使用任何功能，您需要在您打算使用的所有rust_icu_*crates中激活该功能。如果不这样做，可能会导致编译结果令人困惑。

先决条件

必需

• 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。

可选

• 如果您想使用基于make的构建和测试，则需要GNU 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 支持工作仍在进行中。

以下是制作此库时所做的假设

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

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

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

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

  此外，此库的存在并不会阻止重新实现。如果有人想尝试重新实现 ICU，那也行。

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

  低级 ICU API 可能不适合最终用户。应在这些绑定之上分层一个 rust-ful 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 库的配置，并打算从源代码重新构建库，您可能需要添加一个中间的 make clean 命令。

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

为 ICU 的某个版本编译

假设

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

或:

• 您已手动验证，所使用的 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'

以下是一个尚未经过测试的示例，编译 rust_icu 对抗现有的 ICU 版本 66。

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 方法，在假设底层 C API 没有太大差异的情况下，应该可以生成 ICU 库的新版本的库包装器。

一种实现了对 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，它用于 docker 容器。环境变量原封不动地传递给 cargo test，不加引号，因此环境中的单词在 cargo test 中作为单独的参数。
• 环境变量 DOCKER_TEST_ENV 是用于运行测试的 Docker 容器的基准名称。容器 rust_icu_testenv-67 是一个包含预安装环境的容器镜像，其中包含 ICU 67 的编译版本。

刷新静态 bindgen 文件

需要 Docker。

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

调用此 make 目标将修改带有较新版本的本地检查的文件 lib_XX.rs。提交一个 pull request 并进行检查。

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