disk_reader.hpp

1. Overview

The disk_reader.hpp file provides bounded random-access reads over block devices and disk-image files.

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

Primary responsibilities:

  • Open a source in read-only mode
  • Read exact byte ranges
  • Report source size and read errors
  • Provide a common reader abstraction to filesystem parsers

2. File Identity and Scope

  • Source path: src/disk_reader.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 31
  • Non-empty lines: 25
  • SHA-256: 563d7f354bd805828c866d02c537293d0d07b604966794088ef49bc5b265136a

The declarations in this file use the global namespace.

3. Dependencies

3.2 Standard and External Headers

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

  • class DiskReader.

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:

  • int fd_
  • bool is_block_device_
  • uint64_t size_
  • uint32_t logical_sector_size_
  • std::string path_

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

The following callable interfaces or definitions were detected:

  • ~DiskReader() – Destroys the object and releases resources owned by the instance.
  • bool open_readonly(const std::string&path,std::string&error) – Manages the corresponding resource lifecycle or resets internal state.
  • void close() – Manages the corresponding resource lifecycle or resets internal state.
  • bool is_open()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool is_block_device()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • uint64_t size()const – Implements the operation identified by this API and updates or returns the associated state.
  • uint32_t logical_sector_size()const – Implements the operation identified by this API and updates or returns the associated state.
  • bool read_at(uint64_t offset,void*buffer,size_t len) – Reads or derives the requested information and returns or stores the decoded result.
  • std::vector<std::byte> read_block(uint64_t offset,size_t len) – Reads or derives the requested information and returns or stores the decoded result.

8. Operational Flow

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

  1. Open a source in read-only mode.
  2. Read exact byte ranges.
  3. Report source size and read errors.
  4. Provide a common reader abstraction to filesystem parsers.
  5. Expose or execute the detected APIs: ~DiskReader, open_readonly, close, is_open, is_block_device, size, logical_sector_size, read_at, read_block.
  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.
  • 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.
  • File descriptors and streams must be closed on success, cancellation and error paths.

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: