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找到。

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

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

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

• 像Fuchsia这样的项目已经依赖于 ICU，而 Rust 绑定允许以简单的方式使用 Unicode 算法，而无需承担更多依赖。

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

仓库结构

仓库组织为一个 cargo 工作空间，其中每个 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 库版本执行了自动测试（因此可以构建文档）。

特性

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用户指南。

• 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 低级库，用于 rust。

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

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

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

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

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

  低级ICU API可能不适合最终用户。应在这些绑定之上构建一个rust风格的API。可能将此功能细分为crate是一个不错的选择，以符合rust开发者的期望。

  我很乐意重用上述项目中的某些项目已经进行的逻辑细分。

• 我想探讨与现有实现相结合以构建完整的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

假设

• 您已选择功能集 [重命名,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 方法，只要底层的 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 中名为 lib_XX.rs（其中 XX 是 ICU 版本，例如 67）的静态生成的 bindgen 文件，这些文件在 bindgen 功能关闭时使用。

调用此 make 目标将修改带有较新版本 lib_XX.rs 文件的本地检查。提交拉取请求并检查它们。

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