aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5e18870f01ed93072fbb013bbbb2b3affe9ce130
libaaruformat/docs/html/structIndexHeader3.html

220 lines
11 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!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: IndexHeader3 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">&#160;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('structIndexHeader3.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">IndexHeader3 Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3).
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="index_8h_source.html">aaruformat/structs/index.h</a>&gt;</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:a482f94fd93019dd2879d984bc8eecf67" id="r_a482f94fd93019dd2879d984bc8eecf67"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a482f94fd93019dd2879d984bc8eecf67">identifier</a></td></tr>
<tr class="memdesc:a482f94fd93019dd2879d984bc8eecf67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier (must be BlockType::IndexBlock3). <br /></td></tr>
<tr class="memitem:af05fe8e08e929aa0eab6b74638f22b74" id="r_af05fe8e08e929aa0eab6b74638f22b74"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af05fe8e08e929aa0eab6b74638f22b74">entries</a></td></tr>
<tr class="memdesc:af05fe8e08e929aa0eab6b74638f22b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow in this (sub)index block. <br /></td></tr>
<tr class="memitem:a7291ac63956c468bf48aa17d24d3f7b2" id="r_a7291ac63956c468bf48aa17d24d3f7b2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7291ac63956c468bf48aa17d24d3f7b2">crc64</a></td></tr>
<tr class="memdesc:a7291ac63956c468bf48aa17d24d3f7b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the local entries array (does NOT cover subindexes or previous chains). <br /></td></tr>
<tr class="memitem:a33743c206cb10cc1d8ff2c7f9e61ddcf" id="r_a33743c206cb10cc1d8ff2c7f9e61ddcf"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33743c206cb10cc1d8ff2c7f9e61ddcf">previous</a></td></tr>
<tr class="memdesc:a33743c206cb10cc1d8ff2c7f9e61ddcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">File offset of a previous IndexBlock3 header (0 if none / root segment). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3). </p>
<p>Supports flattened hierarchical indexes: entries referencing additional IndexBlock3 subindexes. The 'previous' pointer allows chaining earlier index segments (e.g., incremental append) enabling cumulative discovery without rewriting earlier headers. </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00092">92</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="a7291ac63956c468bf48aa17d24d3f7b2" name="a7291ac63956c468bf48aa17d24d3f7b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7291ac63956c468bf48aa17d24d3f7b2">&#9670;&#160;</a></span>crc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IndexHeader3::crc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA of the local entries array (does NOT cover subindexes or previous chains). </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00096">96</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
Update doxygen documentation.
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l03926">write_index_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="af05fe8e08e929aa0eab6b74638f22b74" name="af05fe8e08e929aa0eab6b74638f22b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af05fe8e08e929aa0eab6b74638f22b74">&#9670;&#160;</a></span>entries</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IndexHeader3::entries</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of <a class="el" href="structIndexEntry.html">IndexEntry</a> records that follow in this (sub)index block. </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00095">95</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
Update doxygen documentation.
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l03926">write_index_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a482f94fd93019dd2879d984bc8eecf67" name="a482f94fd93019dd2879d984bc8eecf67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a482f94fd93019dd2879d984bc8eecf67">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t IndexHeader3::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block identifier (must be BlockType::IndexBlock3). </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00094">94</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
Update doxygen documentation.
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="index__v3_8c_source.html#l00247">add_subindex_entries()</a>, <a class="el" href="index__v3_8c_source.html#l00098">process_index_v3()</a>, <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>, and <a class="el" href="close_8c_source.html#l03926">write_index_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a33743c206cb10cc1d8ff2c7f9e61ddcf" name="a33743c206cb10cc1d8ff2c7f9e61ddcf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33743c206cb10cc1d8ff2c7f9e61ddcf">&#9670;&#160;</a></span>previous</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IndexHeader3::previous</td>
</tr>
</table>
</div><div class="memdoc">
<p>File offset of a previous IndexBlock3 header (0 if none / root segment). </p>
<p class="definition">Definition at line <a class="el" href="index_8h_source.html#l00097">97</a> of file <a class="el" href="index_8h_source.html">index.h</a>.</p>
Update doxygen documentation.
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03926">write_index_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</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="structIndexHeader3.html">IndexHeader3</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>
Reference in New Issue Copy Permalink