Files
libaaruformat/docs/html/structChecksums.html

352 lines
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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: Checksums 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('structChecksums.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">Checksums Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Collected wholeimage checksums / hashes present in a checksum block.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="context_8h_source.html">aaruformat/context.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:acd52d3e5df013ac7e30354d93d41ef72" id="r_acd52d3e5df013ac7e30354d93d41ef72"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acd52d3e5df013ac7e30354d93d41ef72">hasMd5</a></td></tr>
<tr class="memdesc:acd52d3e5df013ac7e30354d93d41ef72"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if md5[] buffer populated. <br /></td></tr>
<tr class="memitem:ac19eb1258cf0bf1c1998dfef7ae52550" id="r_ac19eb1258cf0bf1c1998dfef7ae52550"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac19eb1258cf0bf1c1998dfef7ae52550">hasSha1</a></td></tr>
<tr class="memdesc:ac19eb1258cf0bf1c1998dfef7ae52550"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if sha1[] buffer populated. <br /></td></tr>
<tr class="memitem:a4f404ac9841b3f06f8130722ec613ceb" id="r_a4f404ac9841b3f06f8130722ec613ceb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f404ac9841b3f06f8130722ec613ceb">hasSha256</a></td></tr>
<tr class="memdesc:a4f404ac9841b3f06f8130722ec613ceb"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if sha256[] buffer populated. <br /></td></tr>
<tr class="memitem:aee0cf46a7cf9f514e2b609542820370d" id="r_aee0cf46a7cf9f514e2b609542820370d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aee0cf46a7cf9f514e2b609542820370d">hasBlake3</a></td></tr>
<tr class="memdesc:aee0cf46a7cf9f514e2b609542820370d"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if blake3[] buffer populated. <br /></td></tr>
<tr class="memitem:abe4e66c6bb57259dd1312f5cfb7730a5" id="r_abe4e66c6bb57259dd1312f5cfb7730a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe4e66c6bb57259dd1312f5cfb7730a5">hasSpamSum</a></td></tr>
<tr class="memdesc:abe4e66c6bb57259dd1312f5cfb7730a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if spamsum pointer allocated and signature read. <br /></td></tr>
<tr class="memitem:a9a47b66429ab4db300fdb7fcb931a867" id="r_a9a47b66429ab4db300fdb7fcb931a867"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a47b66429ab4db300fdb7fcb931a867">md5</a> [16]</td></tr>
<tr class="memdesc:a9a47b66429ab4db300fdb7fcb931a867"><td class="mdescLeft">&#160;</td><td class="mdescRight">MD5 digest (16 bytes). <br /></td></tr>
<tr class="memitem:a59a7f4fc7db0867035acf60477afd4a6" id="r_a59a7f4fc7db0867035acf60477afd4a6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a59a7f4fc7db0867035acf60477afd4a6">sha1</a> [20]</td></tr>
<tr class="memdesc:a59a7f4fc7db0867035acf60477afd4a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-1 digest (20 bytes). <br /></td></tr>
<tr class="memitem:a9808d260d9b2ad0c172db164126266a3" id="r_a9808d260d9b2ad0c172db164126266a3"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9808d260d9b2ad0c172db164126266a3">sha256</a> [32]</td></tr>
<tr class="memdesc:a9808d260d9b2ad0c172db164126266a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">SHA-256 digest (32 bytes). <br /></td></tr>
<tr class="memitem:aca24093de3cb292573b7c3ebe777f5e8" id="r_aca24093de3cb292573b7c3ebe777f5e8"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aca24093de3cb292573b7c3ebe777f5e8">blake3</a> [BLAKE3_OUT_LEN]</td></tr>
<tr class="memdesc:aca24093de3cb292573b7c3ebe777f5e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">BLAKE3 digest (32 bytes). <br /></td></tr>
<tr class="memitem:a1748cd355e21a7b0f4f730dd16bd9752" id="r_a1748cd355e21a7b0f4f730dd16bd9752"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1748cd355e21a7b0f4f730dd16bd9752">spamsum</a></td></tr>
<tr class="memdesc:a1748cd355e21a7b0f4f730dd16bd9752"><td class="mdescLeft">&#160;</td><td class="mdescRight">SpamSum fuzzy hash (ASCII), allocated length+1 with trailing 0. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Collected wholeimage checksums / hashes present in a checksum block. </p>
<p>Only hash arrays with corresponding has* flags set contain valid data. spamsum is a dynamically allocated NULterminated buffer (original SpamSum signature bytes followed by appended '\0'). </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00099">99</a> of file <a class="el" href="context_8h_source.html">context.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="aca24093de3cb292573b7c3ebe777f5e8" name="aca24093de3cb292573b7c3ebe777f5e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca24093de3cb292573b7c3ebe777f5e8">&#9670;&#160;</a></span>blake3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Checksums::blake3[BLAKE3_OUT_LEN]</td>
</tr>
</table>
</div><div class="memdoc">
<p>BLAKE3 digest (32 bytes). </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00109">109</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="aee0cf46a7cf9f514e2b609542820370d" name="aee0cf46a7cf9f514e2b609542820370d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee0cf46a7cf9f514e2b609542820370d">&#9670;&#160;</a></span>hasBlake3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Checksums::hasBlake3</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if blake3[] buffer populated. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00104">104</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="acd52d3e5df013ac7e30354d93d41ef72" name="acd52d3e5df013ac7e30354d93d41ef72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd52d3e5df013ac7e30354d93d41ef72">&#9670;&#160;</a></span>hasMd5</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Checksums::hasMd5</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if md5[] buffer populated. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00101">101</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="ac19eb1258cf0bf1c1998dfef7ae52550" name="ac19eb1258cf0bf1c1998dfef7ae52550"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac19eb1258cf0bf1c1998dfef7ae52550">&#9670;&#160;</a></span>hasSha1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Checksums::hasSha1</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if sha1[] buffer populated. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00102">102</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a4f404ac9841b3f06f8130722ec613ceb" name="a4f404ac9841b3f06f8130722ec613ceb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f404ac9841b3f06f8130722ec613ceb">&#9670;&#160;</a></span>hasSha256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Checksums::hasSha256</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if sha256[] buffer populated. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00103">103</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="abe4e66c6bb57259dd1312f5cfb7730a5" name="abe4e66c6bb57259dd1312f5cfb7730a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe4e66c6bb57259dd1312f5cfb7730a5">&#9670;&#160;</a></span>hasSpamSum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Checksums::hasSpamSum</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if spamsum pointer allocated and signature read. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00105">105</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a9a47b66429ab4db300fdb7fcb931a867" name="a9a47b66429ab4db300fdb7fcb931a867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a47b66429ab4db300fdb7fcb931a867">&#9670;&#160;</a></span>md5</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Checksums::md5[16]</td>
</tr>
</table>
</div><div class="memdoc">
<p>MD5 digest (16 bytes). </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00106">106</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a59a7f4fc7db0867035acf60477afd4a6" name="a59a7f4fc7db0867035acf60477afd4a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59a7f4fc7db0867035acf60477afd4a6">&#9670;&#160;</a></span>sha1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Checksums::sha1[20]</td>
</tr>
</table>
</div><div class="memdoc">
<p>SHA-1 digest (20 bytes). </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00107">107</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a9808d260d9b2ad0c172db164126266a3" name="a9808d260d9b2ad0c172db164126266a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9808d260d9b2ad0c172db164126266a3">&#9670;&#160;</a></span>sha256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t Checksums::sha256[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>SHA-256 digest (32 bytes). </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00108">108</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<a id="a1748cd355e21a7b0f4f730dd16bd9752" name="a1748cd355e21a7b0f4f730dd16bd9752"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1748cd355e21a7b0f4f730dd16bd9752">&#9670;&#160;</a></span>spamsum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* Checksums::spamsum</td>
</tr>
</table>
</div><div class="memdoc">
<p>SpamSum fuzzy hash (ASCII), allocated length+1 with trailing 0. </p>
<p class="definition">Definition at line <a class="el" href="context_8h_source.html#l00110">110</a> of file <a class="el" href="context_8h_source.html">context.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="close_8c_source.html#l03997">aaruf_close()</a>, <a class="el" href="checksum_8c_source.html#l00039">process_checksum_block()</a>, and <a class="el" href="close_8c_source.html#l00654">write_checksum_block()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/<a class="el" href="context_8h_source.html">context.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="structChecksums.html">Checksums</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>