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 获取。

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

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

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

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

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

仓库结构

该仓库按rust crates的货仓工作空间组织。每个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的开发版本。

  我们有一个快速入门安装，它可能会在您的环境配置与我们的非常相似，并且您想从源代码构建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 用户指南 提供了如何安装它的说明。

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

  有关如何安装的说明，请参阅 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 图像有点大，因此需要几个 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

假设

• 您已选择功能集 [重命名,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 传递命令行参数。这些参数原样传递给 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 的本地检查。创建一个 pull request 并进行检查。

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