models.hpp

1. Overview

The models.hpp file defines the normalized result, progress, report and recovery records exchanged between modules.

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.

Primary responsibilities:

  • Represent scan candidates and confidence
  • Represent progress notifications
  • Collect scan reports and logs
  • Describe recovered files and operation results

2. File Identity and Scope

  • Source path: src/models.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 42
  • Non-empty lines: 37
  • SHA-256: a7b10bc6b833287e928facb184a8e938fe28c561ac13e5f34b0378229c13ec8c

The declarations in this file use the global namespace.

3. Dependencies

3.2 Standard and External Headers

  • cstdint
  • string
  • vector

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

  • enum class ResultKind.
  • struct ScanResult.
  • struct ScanProgress.
  • struct ScanReport.

4.1 Enumeration Values

ResultKind defines:

  • Partition
  • LostPartitionCandidate
  • FilesystemCandidate
  • FilesystemVolume
  • NtfsVolume
  • NtfsMetadata
  • Info
  • Warning
  • Error

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

The interface declares the following state-bearing members:

  • ResultKind kind {ResultKind::Info}
  • uint64_t offset_bytes {0}
  • uint64_t size_bytes {0}
  • std::string type
  • std::string source
  • std::string detail
  • double confidence {0.0}
  • std::string stage
  • uint64_t bytes_processed {0}
  • uint64_t bytes_total {0}
  • double fraction {0.0}
  • std::string input_path
  • uint64_t input_size {0}
  • std::vector<ScanResult> results
  • std::vector<std::string> logs

These members hold configuration, parser context, UI widgets, source references, progress state, recovered metadata, or temporary resources according to the owning type.

7. API and Function Inventory

No standalone function declaration or definition was detected. The file may consist primarily of structures, constants, templates, aliases, or embedded data.

8. Operational Flow

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

  1. Represent scan candidates and confidence.
  2. Represent progress notifications.
  3. Collect scan reports and logs.
  4. Describe recovered files and operation results.
  5. 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.
  • Byte offsets, sizes and lengths must be validated before arithmetic and before every read to avoid overflow and out-of-bounds access.
  • 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.
  • State-bearing members should have explicit ownership and initialization semantics, especially for references, pointers, file descriptors and GTK widgets.
  • Large-device arithmetic uses 64-bit values; additions and multiplications should be checked before use as offsets or allocation sizes.

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.

Published on:
Last updated on: