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) 的国际组件 (ICU) 库提供低级别本地 Rust 语言绑定的库。

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

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

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

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

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

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

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

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

仓库结构

该存储库以Rust crate的货物工作区组织。每个crate对应ICU4C库的C API中的相应头文件。有关头文件中函数覆盖的详细信息，请参阅覆盖率报告。

限制

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

该库提供的绑定适用性有限，这意味着它可能有时无法直接使用。如果您遇到这种情况，请随时提交一个错误报告以供我们修复。《a href="https://github.com/google/rust_icu/pulls" rel="ugc noopener">拉取请求也欢迎。

我们目前知道的一些限制如下

• 没有保证的功能一致性。一些在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_*crate中激活该特性。未能这样做将导致混乱的编译结果。

先决条件

必需

• 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的情况下取得进展。

可选

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

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

要运行基于 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。可能将这个功能细分到 crates 中，以符合 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

假设

• 您已选择功能集 [重命名,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'

以下是一个尚未测试的示例，说明如何针对现有的 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 方法，只要底层 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。