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 实现。

仓库结构

仓库组织为Rust Crates的cargo工作空间。每个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_*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 低级库用于 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镜像有点大，所以需要几个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 方法，就应该能够为 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 以刷新静态生成的 bindgen 文件（名为 lib_XX.rs，其中 XX 是 ICU 版本，例如 67），这些文件位于 rust_icu_sys/bindgen 目录中，当关闭 bindgen 功能时使用。

调用此 make 目标将修改本地 checkout 的 lib_XX.rs 文件的新版本。创建一个 pull request 并检查它们。

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