gaze-document 0.7.1

Reversible PII pseudonymization for documents — Tesseract OCR + Gaze redact → SafeBundle (clean Markdown + manifest + report).
Documentation 
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

//! Layout / reading-order contract surface.
//!
//! Concrete extraction (column detection, multi-page reading order, table
//! flattening) lands in follow-up PRs. This module reserves the
//! [`ReadingOrder`] handle so adopters can pin against the eventual contract.

use crate::DocumentError;

/// Reading-order handle for a single document.
///
/// Pre-0.1 placeholder — single-page bundles flow through [`crate::clean`]
/// without consulting this type. Multi-page output will route through
/// [`ReadingOrder::infer`] in a follow-up PR.
#[non_exhaustive]
pub struct ReadingOrder {
    _private: (),
}

impl ReadingOrder {
    /// Build a reading-order handle.
    ///
    /// # Errors
    /// Always returns [`DocumentError::NotImplemented`] until the
    /// multi-page PR lands. Single-page bundles never call this; the
    /// placeholder fails loudly so adopters cannot stumble into silent
    /// empty-order output (Axis 1 fail-closed).
    pub fn new() -> Result<Self, DocumentError> {
        Err(DocumentError::NotImplemented(
            "ReadingOrder::new (multi-page deferred to follow-up PR)",
        ))
    }

    /// Infer reading order from raw page payloads.
    ///
    /// # Errors
    /// Returns [`DocumentError::NotImplemented`] until the multi-page PR
    /// lands. Single-page bundles do not need this path.
    pub fn infer(_pages: &[&[u8]]) -> Result<Self, DocumentError> {
        Err(DocumentError::NotImplemented(
            "ReadingOrder::infer (multi-page deferred to follow-up PR)",
        ))
    }
}