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

Updated documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-13 14:26:33 +01:00
parent 556537c79e
commit 4f2e0f05c1
51 changed files with 4177 additions and 1384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/html/internal_8h_source.html
View File

@@ -153,8 +153,9 @@ $(function(){initNavTree('internal_8h_source.html','',''); });
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>uint64_t <a class="code hl_function" href="internal_8h.html#a36c1cca0e4cea9c2e0dffb582b836f6f">get_filetime_uint64</a>();</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>int32_t <a class="code hl_function" href="internal_8h.html#a2402812f5e04ba16765208c0b70fa6c5">aaruf_close_current_block</a>(<a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> *ctx);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keywordtype">int</span> <a class="code hl_function" href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *a, <span class="keyword">const</span> <span class="keywordtype">void</span> *b);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_INTERNAL_H</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keywordtype">void</span> <a class="code hl_function" href="internal_8h.html#a7db9f44b931877b306de9cf7cd1deed2">generate_random_bytes</a>(uint8_t *buffer, <span class="keywordtype">size_t</span> length);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_INTERNAL_H</span></div>
<div class="ttc" id="ainternal_8h_html_a0e2cfc858c0551bc9bef11d5bdb85aac"><div class="ttname"><a href="internal_8h.html#a0e2cfc858c0551bc9bef11d5bdb85aac">process_dumphw_block</a></div><div class="ttdeci">void process_dumphw_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a dump hardware block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2dump_8c_source.html#l00108">dump.c:108</a></div></div>
<div class="ttc" id="ainternal_8h_html_a1906cbcaef9f44b8ac4360beb70a0120"><div class="ttname"><a href="internal_8h.html#a1906cbcaef9f44b8ac4360beb70a0120">set_ddt_entry_v2</a></div><div class="ttdeci">bool set_ddt_entry_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00988">ddt_v2.c:988</a></div></div>
<div class="ttc" id="ainternal_8h_html_a1baad6508d1cde5a712794e956fb3d3c"><div class="ttname"><a href="internal_8h.html#a1baad6508d1cde5a712794e956fb3d3c">process_index_v2</a></div><div class="ttdeci">UT_array * process_index_v2(aaruformat_context *ctx)</div><div class="ttdoc">Processes an index block (version 2) from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v2_8c_source.html#l00081">index_v2.c:81</a></div></div>
@@ -171,6 +172,7 @@ $(function(){initNavTree('internal_8h_source.html','',''); });
<div class="ttc" id="ainternal_8h_html_a5e0397faed8aea27c5a6a3881875de54"><div class="ttname"><a href="internal_8h.html#a5e0397faed8aea27c5a6a3881875de54">process_cicm_block</a></div><div class="ttdeci">void process_cicm_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a CICM XML metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00306">metadata.c:306</a></div></div>
<div class="ttc" id="ainternal_8h_html_a69ff2e68fe4d92a2d2d469ac69f41d82"><div class="ttname"><a href="internal_8h.html#a69ff2e68fe4d92a2d2d469ac69f41d82">set_ddt_multi_level_v2</a></div><div class="ttdeci">bool set_ddt_multi_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a multi-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01092">ddt_v2.c:1092</a></div></div>
<div class="ttc" id="ainternal_8h_html_a7471ae33a70bae7e3aa93a52f8e519ca"><div class="ttname"><a href="internal_8h.html#a7471ae33a70bae7e3aa93a52f8e519ca">set_ddt_single_level_v2</a></div><div class="ttdeci">bool set_ddt_single_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a single-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01023">ddt_v2.c:1023</a></div></div>
<div class="ttc" id="ainternal_8h_html_a7db9f44b931877b306de9cf7cd1deed2"><div class="ttname"><a href="internal_8h.html#a7db9f44b931877b306de9cf7cd1deed2">generate_random_bytes</a></div><div class="ttdeci">void generate_random_bytes(uint8_t *buffer, size_t length)</div><div class="ttdoc">Generates cryptographically strong random bytes.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00480">helpers.c:480</a></div></div>
<div class="ttc" id="ainternal_8h_html_a805d607b45bb8ad8a3e6b0bcfabe3265"><div class="ttname"><a href="internal_8h.html#a805d607b45bb8ad8a3e6b0bcfabe3265">decode_ddt_entry_v2</a></div><div class="ttdeci">int32_t decode_ddt_entry_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t *offset, uint64_t *block_offset, uint8_t *sector_status)</div><div class="ttdoc">Decodes a DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00507">ddt_v2.c:507</a></div></div>
<div class="ttc" id="ainternal_8h_html_a81d410de6727d95a85b827067e1a8bc6"><div class="ttname"><a href="internal_8h.html#a81d410de6727d95a85b827067e1a8bc6">process_geometry_block</a></div><div class="ttdeci">void process_geometry_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a logical geometry block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00246">metadata.c:246</a></div></div>
<div class="ttc" id="ainternal_8h_html_a8241636367dc185ee88d1dc5af9caf59"><div class="ttname"><a href="internal_8h.html#a8241636367dc185ee88d1dc5af9caf59">set_ddt_tape</a></div><div class="ttdeci">bool set_ddt_tape(aaruformat_context *ctx, uint64_t sector_address, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a DDT entry for tape media using a hash-based lookup table.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01768">ddt_v2.c:1768</a></div></div>
@@ -181,7 +183,7 @@ $(function(){initNavTree('internal_8h_source.html','',''); });
<div class="ttc" id="ainternal_8h_html_aa76718b0402b1a28be3d563d5e62028e"><div class="ttname"><a href="internal_8h.html#aa76718b0402b1a28be3d563d5e62028e">process_tape_partitions_block</a></div><div class="ttdeci">void process_tape_partitions_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a tape partition metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l00346">tape.c:346</a></div></div>
<div class="ttc" id="ainternal_8h_html_aaae42bff244df727b6c029f58d4957df"><div class="ttname"><a href="internal_8h.html#aaae42bff244df727b6c029f58d4957df">parse_options</a></div><div class="ttdeci">aaru_options parse_options(const char *options)</div><div class="ttdoc">Parses the options string for AaruFormat image creation/opening.</div><div class="ttdef"><b>Definition</b> <a href="options_8c_source.html#l00038">options.c:38</a></div></div>
<div class="ttc" id="ainternal_8h_html_abaf38090f967423898b99e0455751c07"><div class="ttname"><a href="internal_8h.html#abaf38090f967423898b99e0455751c07">process_ddt_v1</a></div><div class="ttdeci">int32_t process_ddt_v1(aaruformat_context *ctx, IndexEntry *entry, bool *found_user_data_ddt)</div><div class="ttdoc">Processes a DDT v1 block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v1_8c_source.html#l00085">ddt_v1.c:85</a></div></div>
<div class="ttc" id="ainternal_8h_html_ac93ebc6d918745be56b680e19bf7e8d5"><div class="ttname"><a href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a></div><div class="ttdeci">int compare_extents(const void *a, const void *b)</div><div class="ttdoc">Comparison function for sorting DumpExtent arrays by start sector.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00451">helpers.c:451</a></div></div>
<div class="ttc" id="ainternal_8h_html_ac93ebc6d918745be56b680e19bf7e8d5"><div class="ttname"><a href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a></div><div class="ttdeci">int compare_extents(const void *a, const void *b)</div><div class="ttdoc">Comparison function for sorting DumpExtent arrays by start sector.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00459">helpers.c:459</a></div></div>
<div class="ttc" id="ainternal_8h_html_ad7ed9250463c320c7bc8d83689bcfefb"><div class="ttname"><a href="internal_8h.html#ad7ed9250463c320c7bc8d83689bcfefb">verify_index_v3</a></div><div class="ttdeci">int32_t verify_index_v3(aaruformat_context *ctx)</div><div class="ttdoc">Verifies the integrity of an index block (version 3) in the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v3_8c_source.html#l00408">index_v3.c:408</a></div></div>
<div class="ttc" id="ainternal_8h_html_ae234e22b16b085d18614110630034db5"><div class="ttname"><a href="internal_8h.html#ae234e22b16b085d18614110630034db5">verify_index_v2</a></div><div class="ttdeci">int32_t verify_index_v2(aaruformat_context *ctx)</div><div class="ttdoc">Verifies the integrity of an index block (version 2) in the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v2_8c_source.html#l00227">index_v2.c:227</a></div></div>
<div class="ttc" id="ainternal_8h_html_aff88fae9938d5f56318bfd7a455d5e94"><div class="ttname"><a href="internal_8h.html#aff88fae9938d5f56318bfd7a455d5e94">process_index_v3</a></div><div class="ttdeci">UT_array * process_index_v3(aaruformat_context *ctx)</div><div class="ttdoc">Processes an index block (version 3) from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v3_8c_source.html#l00098">index_v3.c:98</a></div></div>