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 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库版本进行自动测试（因此可以构建文档）。

特性

希望编译器与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。

可选

• 如果您想使用基于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 的支持工作仍在进行中。

以下是创建此库时的假设

• 我们需要一个完整、可重用且无痛苦的 ICU 低位库，用于 Rust。

  这意味着我们必须依赖于外部 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 库的配置，并有意从源代码重新构建库，那么您可能需要添加一个中间的 make clean 命令。

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

为 ICU 的某个版本编译

假设

• 您已选择了功能集 [renaming,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 文件的本地检查。发起一个拉取请求并检查它们。

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