1. Overview
The report_exporter.hpp file serializes scan and recovery results into user-readable reports.
This is an interface and data-contract file. It declares the public and internal types used by this subsystem, allowing implementation files and callers to share a stable compile-time contract.
Its paired source or interface file is report_exporter.cpp.
Primary responsibilities:
- Format source and result metadata
- Write report files
- Include logs, confidence and offsets
- Provide an auditable recovery summary
2. File Identity and Scope
- Source path:
src/report_exporter.hpp - Language: C++
- File role: interface and data-contract file
- Physical lines: 11
- Non-empty lines: 8
- SHA-256:
b332943808c6bdbcf794bee96a1ca912a33cc616c731479a9ce8051b29f0712f
The declarations in this file use the global namespace.
3. Dependencies
3.1 Project Headers
models.hpp
3.2 Standard and External Headers
string
These dependencies define the file’s compile-time integration with the recovery engine, GTK interface, on-disk format decoders, operating-system services, or C++ standard library.
4. Declared Types
- class
ReportExporter.
5. Constants and Configuration Values
No preprocessor or compile-time constants were detected as top-level declarations in this file.
6. Data Members and Persistent State
No class data members are declared directly in this file, or the file primarily implements methods declared elsewhere.
7. API and Function Inventory
The following callable interfaces or definitions were detected:
static bool save_json(const ScanReport&report,const std::string&path,std::string&error_out)– Persists or exports the supplied state to the relevant destination.static bool save_text(const ScanReport&report,const std::string&path,std::string&error_out)– Persists or exports the supplied state to the relevant destination.
8. Operational Flow
The subsystem represented by this file normally participates in the following flow:
- Format source and result metadata.
- Write report files.
- Include logs, confidence and offsets.
- Provide an auditable recovery summary.
- Expose or execute the detected APIs:
save_json, save_text. - Return explicit results, progress data, recovered records, or diagnostics to the calling layer.
9. Validation and Error Handling
- Errors are propagated through Boolean results, error strings, logs, exceptions, or status records depending on the API.
- Input and output paths require existence checks, permission handling and safe destination construction.
10. Runtime, Concurrency, and Resource Management
- Deterministic behavior: callers depend on explicit return values and stable data structures to distinguish successful recovery from partial or invalid results.
11. Security and Data-Recovery Considerations
- Recovery code should prefer read-only source access and avoid writing to the original damaged medium.
- Raw devices and image files are treated as untrusted binary input; every offset and length must remain bounded by the source size.
- Recovered names and destination paths must be sanitized to prevent directory traversal and accidental overwrite outside the selected export directory.
12. Implementation Considerations
- Changes to public declarations can affect every translation unit that includes this header and should preserve binary and source compatibility where required.
13. Integration with the Recovery Pipeline
- The file belongs to the source-discovery, parsing or support layer.
- Its results feed scanner, recovery or reporting modules through shared models.
- The API should remain deterministic so higher layers can combine results safely.
14. Licensing and Provenance
No explicit copyright or software-license statement was detected in the opening section of this individual file. Distribution terms should therefore be verified against the project-level license and repository metadata.
The SHA-256 value in this document can be used to associate the generated documentation with the exact source version analyzed.