rapid-structure-rs 1.0.0

Rust document-structure engine for PaddleOCR-family ONNX models: text detection/recognition (PP-OCRv6), table structure (SLANet-plus) and formula recognition (PP-FormulaNet) on Windows x64 via ONNX Runtime.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! `rapid-structure-rs`：用 Rust 调用 PP-OCR / PP-FormulaNet 系列 ONNX 模型。
//!
//! # 平台支持
//!
//! **唯一支持的平台是 Windows x64 + MSVC ABI（`x86_64-pc-windows-msvc`）。**
//!
//! 这是刻意的收窄，而不是尚未移植：项目的实际运行环境只有 Windows x64，
//! 保留 Linux/macOS 分支会让平台差异散落到业务代码里，并让验证矩阵无法收敛。
//!
//! 明确非目标：**Windows x86（i686，32 位）**、**Windows ARM64**、
//! **Windows GNU ABI（`x86_64-pc-windows-gnu` / `i686-pc-windows-gnu`）**，
//! 以及 Wine、WSL、Linux、macOS。
//!
//! Windows x86 不是“改一个 `cfg` 就能支持”的：预编译的 ONNX Runtime、
//! DirectML/CUDA 的 provider DLL 与约 566 MB 的公式识别模型都是 x64 产物，
//! 32 位地址空间对后者本身就是真实限制；Windows ARM64 则要重新收集并重测整套原生依赖。
//! 若将来需要，另立平台计划，而不是在这里逐步加回 `cfg`。
//!
//! 平台边界集中在 crate 根部，规则只有四条：
//!
//! 1. 门槛写在 `src/platform_gate.rs`（唯一定义处，无任何依赖），可以用
//!    `tools/check_platform_gate.ps1` 单独对非支持 target 验证“命中的是
//!    我们自己的错误信息”；
//! 2. 所有模块与重导出都带**同一个** `#[cfg]` 谓词，因此非支持平台**只会**看到那一条
//!    `compile_error!`，不会退化成一堆“缺少某个 Windows API”的模糊诊断；
//! 3. 谓词是 `all(windows, target_arch = "x86_64", target_env = "msvc")`，**必须带
//!    `target_env = "msvc"`**：`x86_64-pc-windows-gnu` 同样满足 `windows + x86_64`
//!    但不是支持目标，而 32 位 x86（`i686-pc-windows-msvc` / `i686-pc-windows-gnu`）
//!    不满足 `target_arch = "x86_64"`；本 crate 的导入库、
//!    `#[link(name = "psapi")]` 与 ort 预编译运行库都是 MSVC x64 产物
//!    （见 `platform_gate.rs`）；
//! 4. 业务代码内部不再散布 `cfg(windows)`；平台差异只允许出现在
//!    `runtime/memory.rs` 这类平台实现模块里。
//!
//! 谓词重复出现，因此用 `cfg!` 断言把它锁住：`platform_gate_matches_the_module_predicate`
//! 测试会在**错误的 target**（例如 GNU）上编译测试套件时直接失败，而不是静默地
//! 用一套与门槛不一致的谓词继续构建。

#[path = "platform_gate.rs"]
mod platform_gate;

#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod api;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod config;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod error;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
pub mod evaluation;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod exports;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod formula;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod input;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod model_registry;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod model_set;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod model_source;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod model_store;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod model_verify;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod ocr;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod output;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod runtime;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod table;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc", test))]
mod test_support;
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
mod vision;

/// 公开 API 的唯一入口（见 `src/exports.rs`）。
///
/// 平台谓词只在这一处出现，避免在十几个 `pub use` 上重复。
#[cfg(all(windows, target_arch = "x86_64", target_env = "msvc"))]
pub use exports::*;

#[cfg(test)]
mod platform_tests {
    /// 构建目标必须与 [`crate::platform_gate`] 允许的平台完全一致。
    ///
    /// `platform_gate.rs` 与 `lib.rs` 里的 `#[cfg]` 是同一个谓词的两份拷贝；如果只改对
    /// 一处，另一处会静默地把错误目标放进来（`x86_64-pc-windows-gnu` 就同时满足
    /// `windows` 与 `target_arch = "x86_64"`）。
    ///
    /// 这条 `const` 断言在**错误 target 上构建测试套件**时直接编译失败，因此不可能
    /// “跑过了但还是错的”：
    ///
    /// ```text
    /// error[E0080]: evaluation of constant value failed
    /// rapid-structure-rs only supports x86_64-pc-windows-msvc ...
    /// ```
    const _: () = {
        assert!(
            cfg!(all(windows, target_arch = "x86_64", target_env = "msvc")),
            "rapid-structure-rs only supports x86_64-pc-windows-msvc; this test suite is being built \
             for a different target"
        );
    };

    /// 上一条断言是编译期的；这里再把**实际**的 target 打进测试输出，
    /// 让 `cargo test` 的日志本身就能证明跑的是 Windows x86_64 MSVC。
    ///
    /// 这里刻意**不**再写 `cfg!(target_env = "msvc")` 断言：那是常量断言，clippy 的
    /// `assertions_on_constants` 会（正确地）报错，而且它已经被上面的 `const` 块覆盖。
    /// 这里断言的是运行期可见的三元组，两者互相独立。
    #[test]
    fn the_test_suite_runs_on_the_gated_target() {
        assert_eq!(
            std::env::consts::OS,
            "windows",
            "the only supported platform is Windows x64 + MSVC ABI"
        );
        assert_eq!(
            std::env::consts::ARCH,
            "x86_64",
            "the only supported platform is Windows x64 + MSVC ABI"
        );
        assert_eq!(
            std::env::consts::FAMILY,
            "windows",
            "the crate targets the Windows family"
        );
        eprintln!(
            "target: os={} arch={} family={} (the compile-time predicate also requires \
             target_env = \"msvc\")",
            std::env::consts::OS,
            std::env::consts::ARCH,
            std::env::consts::FAMILY
        );
    }
}