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不同。

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

我们目前知道的限制如下

• 无法保证功能兼容性。一些在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_* 包中激活功能。未能这样做将导致编译结果令人困惑。

先决条件

必需

• 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的支持工作仍在进行中。

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

• 我们需要一个完整、可重用且易于使用的Rust低级ICU库。

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

• 本库的工作不会重新实现任何ICU算法。

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

  此外，此库的存在并不阻止重新实现。如果有人想尝试重新实现ICU，那也很好。

• 此库应作为 Rust 实现的低级基础。

  低级 ICU API 可能不适合最终用户。应在这些绑定之上构建一个 rust-ful API。将功能细分为 crate，以符合 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 的特定版本编译

假设

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

以下是一个尚未测试的示例，即针对预存在的 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 中名为 lib_XX.rs 的静态生成的 bindgen 文件（其中 XX 是 ICU 版本，例如 67），这些文件在 bindgen 功能关闭时使用。

调用此 make 目标将修改带有 lib_XX.rs 文件的新版本的本地签出。创建拉取请求并签入它们。

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