mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
202 lines
17 KiB
HTML
202 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.14.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libaaruformat: IndexEntry Struct Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">libaaruformat<span id="projectnumber"> 1.0</span>
|
|
</div>
|
|
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.14.0 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',true);
|
|
$(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('structIndexEntry.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">IndexEntry Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Single index entry describing a block's type, (optional) data classification, and file offset.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="index_8h_source.html">aaruformat/structs/index.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:a4b5c7115ac83019c3f77c6f047e5f75e" id="r_a4b5c7115ac83019c3f77c6f047e5f75e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4b5c7115ac83019c3f77c6f047e5f75e">blockType</a></td></tr>
|
|
<tr class="memdesc:a4b5c7115ac83019c3f77c6f047e5f75e"><td class="mdescLeft"> </td><td class="mdescRight">Block identifier of the referenced block (value from <a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3">BlockType</a>). <br /></td></tr>
|
|
<tr class="memitem:ae5d35082a756e0388efbf5fabbe93d10" id="r_ae5d35082a756e0388efbf5fabbe93d10"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5d35082a756e0388efbf5fabbe93d10">dataType</a></td></tr>
|
|
<tr class="memdesc:ae5d35082a756e0388efbf5fabbe93d10"><td class="mdescLeft"> </td><td class="mdescRight">Data classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>) or unused for untyped blocks. <br /></td></tr>
|
|
<tr class="memitem:a854951a64192d7e4cdcfa6dd6fd2b3ea" id="r_a854951a64192d7e4cdcfa6dd6fd2b3ea"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#a854951a64192d7e4cdcfa6dd6fd2b3ea">offset</a></td></tr>
|
|
<tr class="memdesc:a854951a64192d7e4cdcfa6dd6fd2b3ea"><td class="mdescLeft"> </td><td class="mdescRight">Absolute byte offset in the image where the referenced block header begins. <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Single index entry describing a block's type, (optional) data classification, and file offset. </p>
|
|
<p>Semantics by blockType (see <a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3">BlockType</a>):</p><ul>
|
|
<li>DataBlock / GeometryBlock / ChecksumBlock / etc.: dataType conveys specific stored data category (<a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>).</li>
|
|
<li>Deduplication (DDT) or Index blocks: dataType may be ignored or set to a sentinel.</li>
|
|
<li>IndexBlock3: this entry refers to a subindex; offset points to another <a class="el" href="structIndexHeader3.html" title="Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3).">IndexHeader3</a>. </li>
|
|
</ul>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00108">108</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
|
|
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
|
|
<a id="a4b5c7115ac83019c3f77c6f047e5f75e" name="a4b5c7115ac83019c3f77c6f047e5f75e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b5c7115ac83019c3f77c6f047e5f75e">◆ </a></span>blockType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t IndexEntry::blockType</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Block identifier of the referenced block (value from <a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3">BlockType</a>). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00110">110</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00035">process_metadata_block()</a>, <a class="el" href="ddt__v2_8c_source.html#l01092">set_ddt_multi_level_v2()</a>, <a class="el" href="close_8c_source.html#l03812">write_aaru_json_block()</a>, <a class="el" href="close_8c_source.html#l00077">write_cached_secondary_ddt()</a>, <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>, <a class="el" href="close_8c_source.html#l03675">write_cicm_block()</a>, <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l03026">write_geometry_block()</a>, <a class="el" href="close_8c_source.html#l03862">write_index_block()</a>, <a class="el" href="close_8c_source.html#l02409">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l03162">write_metadata_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00283">write_primary_ddt()</a>, <a class="el" href="close_8c_source.html#l00966">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, <a class="el" href="close_8c_source.html#l01088">write_sector_suffix()</a>, <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>, <a class="el" href="close_8c_source.html#l00369">write_single_level_ddt()</a>, <a class="el" href="close_8c_source.html#l02669">write_tape_file_block()</a>, <a class="el" href="close_8c_source.html#l02901">write_tape_partition_block()</a>, and <a class="el" href="close_8c_source.html#l00798">write_tracks_block()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5d35082a756e0388efbf5fabbe93d10" name="ae5d35082a756e0388efbf5fabbe93d10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5d35082a756e0388efbf5fabbe93d10">◆ </a></span>dataType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t IndexEntry::dataType</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Data classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>) or unused for untyped blocks. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00111">111</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="ddt__v2_8c_source.html#l01092">set_ddt_multi_level_v2()</a>, <a class="el" href="close_8c_source.html#l03812">write_aaru_json_block()</a>, <a class="el" href="close_8c_source.html#l00077">write_cached_secondary_ddt()</a>, <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>, <a class="el" href="close_8c_source.html#l03675">write_cicm_block()</a>, <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l03026">write_geometry_block()</a>, <a class="el" href="close_8c_source.html#l03862">write_index_block()</a>, <a class="el" href="close_8c_source.html#l02409">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l03162">write_metadata_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00283">write_primary_ddt()</a>, <a class="el" href="close_8c_source.html#l00966">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, <a class="el" href="close_8c_source.html#l01088">write_sector_suffix()</a>, <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>, <a class="el" href="close_8c_source.html#l00369">write_single_level_ddt()</a>, <a class="el" href="close_8c_source.html#l02669">write_tape_file_block()</a>, <a class="el" href="close_8c_source.html#l02901">write_tape_partition_block()</a>, and <a class="el" href="close_8c_source.html#l00798">write_tracks_block()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a854951a64192d7e4cdcfa6dd6fd2b3ea" name="a854951a64192d7e4cdcfa6dd6fd2b3ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a854951a64192d7e4cdcfa6dd6fd2b3ea">◆ </a></span>offset</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint64_t IndexEntry::offset</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Absolute byte offset in the image where the referenced block header begins. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00112">112</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01383">aaruf_close_current_block()</a>, <a class="el" href="open_8c_source.html#l00125">aaruf_open()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00470">process_aaru_metadata_json_block()</a>, <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00306">process_cicm_block()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00108">process_dumphw_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00246">process_geometry_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00035">process_metadata_block()</a>, <a class="el" href="tape_8c_source.html#l00126">process_tape_files_block()</a>, <a class="el" href="tape_8c_source.html#l00346">process_tape_partitions_block()</a>, <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>, <a class="el" href="ddt__v2_8c_source.html#l01092">set_ddt_multi_level_v2()</a>, <a class="el" href="close_8c_source.html#l03812">write_aaru_json_block()</a>, <a class="el" href="close_8c_source.html#l00077">write_cached_secondary_ddt()</a>, <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>, <a class="el" href="close_8c_source.html#l03675">write_cicm_block()</a>, <a class="el" href="close_8c_source.html#l03445">write_dumphw_block()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l03026">write_geometry_block()</a>, <a class="el" href="close_8c_source.html#l03862">write_index_block()</a>, <a class="el" href="close_8c_source.html#l02409">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l03162">write_metadata_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00283">write_primary_ddt()</a>, <a class="el" href="close_8c_source.html#l00966">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, <a class="el" href="close_8c_source.html#l01088">write_sector_suffix()</a>, <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>, <a class="el" href="close_8c_source.html#l00369">write_single_level_ddt()</a>, <a class="el" href="close_8c_source.html#l02669">write_tape_file_block()</a>, <a class="el" href="close_8c_source.html#l02901">write_tape_partition_block()</a>, and <a class="el" href="close_8c_source.html#l00798">write_tracks_block()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/aaruformat/structs/<a class="el" href="index_8h_source.html">index.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a href="structIndexEntry.html">IndexEntry</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|