Struct FileFactSheet 

pub struct FileFactSheet {
    pub path: String,
    pub sections: Vec<(String, Vec<(String, String)>)>,
}

A deterministic per-file evidence dossier: ordered sections of pre-formatted facts drawn from the analyses. See the module docs for the determinism contract.

Fields

path: String

Repo-relative path the sheet describes.

sections: Vec<(String, Vec<(String, String)>)>

Ordered (section, [(key, value)]) facts — already sorted, values pre-formatted.

Implementations

impl FileFactSheet

pub fn build<R: Repo>( db: &FactsDb, repo: &R, opts: &Options, path: &str, ) -> Result<Self>

Assemble the fact sheet for path from the analyses, in a fixed order.

The code-health section is mandatory: an error naming the path is returned when the path has no code-health row (it is not a tracked source file, or has too few revisions). The hotspots, functions, cycle, and defect-evidence sections are conditional and are simply omitted when they have no data for the path.

Errors

Returns CodeLoreError::Analysis when the path has no code-health data, and propagates any analysis or fact-store error from the feeds.

pub fn to_canonical_text(&self) -> String

Canonical text: the deterministic cache-key + prompt input.

pub fn to_human_text(&self) -> String

Human-readable dossier rendering for explain <path>.

pub fn digest(&self) -> String

Lowercase hex SHA-256 of the canonical text.

pub fn numeric_values(&self) -> Vec<f64>

Every parseable numeric value, for the narrative citation check.

Trait Implementations

impl Clone for FileFactSheet

fn clone(&self) -> FileFactSheet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileFactSheet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.