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文件中执行一些库检测，并使构建过程适应您的构建环境。然而，由于并非每个开发环境都会使用相同的设置，我们选择了某些特性（以下）作为配置选项。

虽然我们的意图是保持以下特性的列表与实际的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 的支持工作仍在进行中。

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

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

  例如，这意味着我们必须依赖外部 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 镜像有点大，因此需要几吉字节的空间来容纳所有这些。
• 您有互联网连接。

从那里，以下命令序列将检出、构建和测试 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_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'

以下是一个尚未测试过的示例，编译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方法，就应该能够为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使用预构建的bindgen源文件rust_icu_sys/bindgen/lib_67.rs，而不是尝试动态生成。
• 环境变量 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 功能时使用。

调用此构建目标将修改本地签出的 lib_XX.rs 文件的新版本。发起一个拉取请求并签入它们。

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