minimize-rust-ffi-crate-surface

Rust FFI クレートの公開範囲を縮小する

Rust FFI クレートまたはファイルで定義されている C シンボルのうち、未使用のもの、または C/C++ の単体テストでのみ使用されているものを削除します。

引数

• <path>：Rust クレートまたはファイルへのパス。
• <path 1> <path 2>：複数の Rust クレートまたはファイル。

パスが src/ で始まらない場合は、src/redisearch_rs/c_entrypoint ディレクトリ内にあるものとします。たとえば、numeric_range_tree_ffi は src/redisearch_rs/numeric_range_tree_ffi になります。 パスがディレクトリを指している場合は、そのディレクトリにあるすべての Rust ファイルのドキュメントを確認します。

手順

• analyze-rust-ffi-crate-surface を使用して、Rust クレートまたはファイルが公開するすべての FFI シンボル（例：#[unsafe(no_mangle)] が付与された extern "C" fn や型定義）を列挙し、その使用状況を分析します。
• 未使用のシンボルごとに、次の操作を行います。
  • Rust の定義を削除します。
  • C/C++ の単体テストを実行し（./build.sh RUN_UNIT_TESTS）、そのシンボルが本当に未使用であることを確認します。
• C/C++ の単体テストでのみ使用されているシンボルごとに、次のいずれかの計画を詳しく説明します。
  • C/C++ の単体テストをリファクタリングして、そのシンボルを使用しないようにします。
  • そのシンボルに依存する C/C++ の単体テスト（またはアサーション）を削除します。これらは Rust クレートの実装詳細を調べているためです。
  • シンボルを残し、Rust のドキュメントで「テスト専用」と明記します。