rescue_imager.hpp

1. Overview

The rescue_imager.hpp file creates a safer image copy of unstable media while recording damaged regions.

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

Primary responsibilities:

  • Read the source sequentially or in passes
  • Write an image destination
  • Use fault-tolerant reads
  • Track bad and slow ranges
  • Report imaging progress

2. File Identity and Scope

  • Source path: src/rescue_imager.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 32
  • Non-empty lines: 27
  • SHA-256: aca55f5159106d040f0a88215426e25bbfbdad5f11f8240319e84c1c22fc4265

The declarations in this file use the global namespace.

3. Dependencies

3.1 Project Headers

  • bad_block_map.hpp
  • fault_tolerant_reader.hpp

3.2 Standard and External Headers

  • cstdint
  • functional
  • 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

  • struct RescueImageReport.
  • class RescueImager.

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:

  • std::string image_path
  • std::string map_path
  • uint64_t bytes_requested {0}
  • uint64_t bytes_written {0}
  • uint64_t bad_ranges {0}
  • std::vector<std::string> logs
  • CancelCallback cancel_cb={})

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. Read the source sequentially or in passes.
  2. Write an image destination.
  3. Use fault-tolerant reads.
  4. Track bad and slow ranges.
  5. Report imaging progress.
  6. 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.

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: