fdu-core 0.3.0

The fdu engine: incremental hierarchical tallies over large directory trees
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

//! Optional, versioned file-content analysis.
//!
//! Metadata-only scans allocate none of these structures and open no file content.
//!
//! An analysis pass reads each file in 64 KiB chunks, schedules its candidates in
//! bounded batches, classifies code lines in pieces over a bounded window
//! ([`CodeAccumulator`]), and never truncates or size-skips an eligible file. One thing
//! is retained whole per worker, because an exact answer needs it: the source of a
//! Markdown file under the words unit, since the `CommonMark` parser resolves list
//! tightness, headings, and references across the whole document. That is bounded at
//! 64 MiB (`MARKDOWN_EXACT_BYTES`, stated with its reason in the analysis module): a
//! larger Markdown file is counted as plain text and its record says so
//! ([`CoverageReason::TextOnly`]). A file of another type retains at most its 16 KiB
//! classification prefix and one chunk once the prefix has settled its type.

mod content_analysis;
mod content_basic_metrics;
mod content_cache;
mod content_code_metrics;
mod content_index;
mod content_markdown_metrics;
mod content_model;

pub use content_analysis::{AnalysisReport, AnalyzerCoverage, analyze_index};
pub(crate) use content_analysis::{MARKDOWN_EXACT_BYTES, analyze_index_observed};
pub use content_basic_metrics::{BasicAccumulator, TextAdmission};
pub use content_cache::{
    ContentCacheLoad, content_cache_path, load_content_cache, save_content_cache,
};
pub(crate) use content_cache::{content_sidecar_bytes, identify_sidecar};
pub use content_code_metrics::CodeAccumulator;
pub(crate) use content_index::ContentTierState;
pub use content_index::{AnalyzerTally, ContentIndex, ContentRollUp, MetricTally};
pub(crate) use content_model::{
    AnalysisApplyOutcome, AnalysisCandidate, AnalysisObservation, RestoreCandidate,
};
pub use content_model::{
    AnalysisRequest, AnalysisSet, AnalyzerId, AnalyzerOutcome, AnalyzerVersion, BasicMetrics,
    CODE_SLOC, CONTENT_BASIC, CodeMetrics, ContentDetection, ContentProvenance, CoverageReason,
    FileAnalysis, LogicalWordStats, MARKDOWN_PROSE, METRICS, MetricDef, MetricValues,
    OptionsFingerprint, TEXT_LOGICAL, WordMetrics,
};