Skip to main content

report

Function report 

Source
pub fn report(
    index: &Index,
    request: &Request,
    generated_at: SystemTime,
) -> Result<Report>
Expand description

Build a report from an index.

Pure: the same index, request, and provenance always produce the same report, and nothing here reads the filesystem or mutates the index.

§Errors

Error::InvalidRequest when this index cannot answer the request: it holds another analyzer set than the read asks for, a view needs content nothing analyzed, or the request selects by ignored state (Selection::ignored) over an index that read no .gitignore – which can say of no entry that it is ignored or that it is not, so the request is refused rather than answered with every entry or none.