scanner_engine.hpp

1. Overview

The scanner_engine.hpp file coordinates partition parsing, lost-partition discovery, filesystem probes, signature scans and health checks.

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 scanner_engine.cpp.

Primary responsibilities:

  • Open the selected source
  • Collect source and health metadata
  • Parse known partitions
  • Search for lost filesystems
  • Detect encrypted volumes and file signatures
  • Build a unified scan report

2. File Identity and Scope

  • Source path: src/scanner_engine.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 15
  • Non-empty lines: 12
  • SHA-256: 045f55e2b44c2fc465a9796e0135da2e1696f331b10b0f2da6000e34642ce911

The declarations in this file use the global namespace.

3. Dependencies

3.1 Project Headers

  • models.hpp

3.2 Standard and External Headers

  • functional
  • 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 ScannerEngine.

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:

  • ScanReport run_scan(const std::string&path,ProgressCallback progress_cb,std::function<bool()> cancel_cb) – Implements the operation identified by this API and updates or returns the associated state.

8. Operational Flow

The subsystem represented by this file normally participates in the following flow:

  1. Open the selected source.
  2. Collect source and health metadata.
  3. Parse known partitions.
  4. Search for lost filesystems.
  5. Detect encrypted volumes and file signatures.
  6. Build a unified scan report.
  7. Expose or execute the detected APIs: run_scan.
  8. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • 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.

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 orchestration layer between the UI and low-level parsers.
  • It aggregates progress, results and diagnostics from multiple modules.
  • It should preserve cancellation and completion semantics across thread boundaries.

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.

Published on:
Last updated on: