text-mirror 0.5.0

Converts binary and rich files into text and builds a replica text-mirror tree beside a manifest recording the source, hash, and converter behind every artifact
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
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

//! JSON summary types the CLI verbs emit.

use serde::{Deserialize, Serialize};

use crate::manifest::Record;

/// Inventory of one detected format in a scan.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FormatCount {
    /// Format id.
    pub format: String,
    /// Number of files.
    pub files: u64,
    /// Total size in bytes.
    pub bytes: u64,
}

/// A file whose size stands out from the rest of the tree.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SizeOutlier {
    /// Path relative to the scanned root.
    pub path: String,
    /// Size in bytes.
    pub bytes: u64,
    /// Detected format id.
    pub format: String,
}

/// The `scan` verb output. A dry-run inventory of a division root.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ScanReport {
    /// The scanned root.
    pub root: String,
    /// Version of the rules files used for detection.
    pub rules_version: String,
    /// Total number of files.
    pub files: u64,
    /// Total size in bytes.
    pub bytes: u64,
    /// Per-format counts, sorted by format id.
    pub formats: Vec<FormatCount>,
    /// Size outliers, largest first.
    pub outliers: Vec<SizeOutlier>,
}

/// Terminal record counts by status.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StatusCounts {
    /// Sources with a fresh text artifact.
    pub converted: u64,
    /// Sources whose conversion failed.
    pub failed: u64,
    /// Sources no converter claims.
    pub unsupported: u64,
    /// Sources skipped because the checkpoint key matched.
    pub skipped_unchanged: u64,
    /// Sources deduplicated against an identical source.
    pub dedup: u64,
}

/// The `run` verb output.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RunReport {
    /// The division that ran.
    pub division: String,
    /// The division root.
    pub root: String,
    /// Number of walked sources that received a manifest record.
    pub sources: u64,
    /// Walked entries with no manifest representation yet, meaning
    /// FIFOs, sockets, and other special files.
    pub special_entries: u64,
    /// Outcome counts for this run.
    pub counts: StatusCounts,
    /// Non-fatal findings, such as a discarded torn manifest line.
    pub warnings: Vec<String>,
}

/// Coverage for one division, computed over terminal records.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DivisionStatus {
    /// Division name, from the shard file name.
    pub division: String,
    /// Number of distinct source paths.
    pub sources: u64,
    /// Sources whose terminal record carries a text artifact.
    pub with_text: u64,
    /// `with_text` over `sources`, 0.0 for an empty shard.
    pub coverage: f64,
    /// Terminal record counts by status.
    pub counts: StatusCounts,
    /// Non-fatal reader findings for this shard.
    pub warnings: Vec<String>,
}

/// The `status` verb output.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct StatusReport {
    /// One entry per division shard, sorted by division name.
    pub divisions: Vec<DivisionStatus>,
}

/// One manifest record with the division shard it came from.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ExplainEntry {
    /// Division name, from the shard file name.
    pub division: String,
    /// The record as written.
    pub record: Record,
}