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

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

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

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

• 像 Fuchsia 这样的项目已经依赖于 ICU，并且具有 Rust 绑定，这使得在不承担更多依赖项的情况下轻松使用 Unicode 算法成为可能。

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

仓库结构

该仓库按照 Rust 软件包的形式组织。每个软件包对应 ICU4C 库 C API 中的相应头文件。请参考覆盖率报告以获取头文件中函数覆盖的详细信息。

限制

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

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

我们目前知道的局限性如下：

• 没有保证的功能一致性。某些在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的情况下顺利进行。

可选

• 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 低级库。

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

• 不会在库的工作中重新实现 ICU 算法。

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

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

• 此库应作为Rust实现的底层基础。

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

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

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

  希望可以将所有可用的Rust绑定的优点结合起来，形成一个统一的Rust库。我随时可以讨论选项。

  我之所以开始一个单独的努力而不是向“现有技术”部分中列出的任何项目贡献，只是因为我想要尝试在Rust中生成的库看起来会是什么样子。

附加说明

快速入门指南

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

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

从那里，以下命令序列将检出、构建和测试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 方法得到支持，就可以为 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 目标将修改包含较新版本文件的本地 checkout（名为 lib_XX.rs）。发起拉取请求并检查它们。

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