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 crate的货物工作空间的形式组织。每个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. 对文档.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可能不适合最终用户。应该在这些绑定之上构建一个Rust 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库的配置，并有意从源代码重新构建库，您可能需要添加一个中间的make clean命令。

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

编译特定版本的 ICU

假设

• 您已选择以下功能集 [renaming,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 方法，只要底层 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。