Loading...
Searching...
No Matches
IndexEntry Struct Reference

Single index entry describing a block's type, (optional) data classification, and file offset. More...

`#include <aaruformat/structs/index.h>`

## Data Fields

uint32_t | blockType
| Block identifier of the referenced block (value from BlockType).
uint16_t | dataType
| Data classification (value from DataType) or unused for untyped blocks.
uint64_t | offset
| Absolute byte offset in the image where the referenced block header begins.

## Detailed Description

Single index entry describing a block's type, (optional) data classification, and file offset.

Semantics by blockType (see BlockType):

- DataBlock / GeometryBlock / ChecksumBlock / etc.: dataType conveys specific stored data category (DataType).
- Deduplication (DDT) or Index blocks: dataType may be ignored or set to a sentinel.
- IndexBlock3: this entry refers to a subindex; offset points to another IndexHeader3.

Definition at line 108 of file index.h.

## Field Documentation

## blockType

uint32_t IndexEntry::blockType

Block identifier of the referenced block (value from BlockType).

Definition at line 110 of file index.h.

Referenced by aaruf_close_current_block(), aaruf_open(), aaruf_verify_image(), add_subindex_entries(), ensure_flux_entries_loaded(), process_data_block(), process_dumphw_block(), process_index_v3(), process_metadata_block(), set_ddt_multi_level_v2(), write_aaru_json_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_flux_blocks(), write_flux_capture_payload(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_file_block(), write_tape_partition_block(), and write_tracks_block().

## dataType

uint16_t IndexEntry::dataType

Data classification (value from DataType) or unused for untyped blocks.

Definition at line 111 of file index.h.

Referenced by aaruf_close_current_block(), aaruf_open(), process_data_block(), process_ddt_v1(), process_ddt_v2(), set_ddt_multi_level_v2(), write_aaru_json_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_flux_blocks(), write_flux_capture_payload(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_file_block(), write_tape_partition_block(), and write_tracks_block().

## offset

uint64_t IndexEntry::offset

Absolute byte offset in the image where the referenced block header begins.

Definition at line 112 of file index.h.

Referenced by aaruf_close_current_block(), aaruf_open(), aaruf_verify_image(), add_subindex_entries(), process_aaru_metadata_json_block(), process_checksum_block(), process_cicm_block(), process_data_block(), process_ddt_v1(), process_ddt_v2(), process_dumphw_block(), process_flux_data_block(), process_geometry_block(), process_metadata_block(), process_tape_files_block(), process_tape_partitions_block(), process_tracks_block(), set_ddt_multi_level_v2(), write_aaru_json_block(), write_cached_secondary_ddt(), write_checksum_block(), write_cicm_block(), write_dumphw_block(), write_dvd_long_sector_blocks(), write_dvd_title_key_decrypted_block(), write_flux_blocks(), write_flux_capture_payload(), write_geometry_block(), write_index_block(), write_media_tags(), write_metadata_block(), write_mode2_subheaders_block(), write_primary_ddt(), write_sector_prefix(), write_sector_prefix_ddt(), write_sector_subchannel(), write_sector_suffix(), write_sector_suffix_ddt(), write_single_level_ddt(), write_tape_file_block(), write_tape_partition_block(), and write_tracks_block().

The documentation for this struct was generated from the following file:

- include/aaruformat/structs/index.h