/usr/share/doc/liblzma-doc/html/structlzma__block.html is in liblzma-doc 5.2.2-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: lzma_block 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>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">lzma_block Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Options for the Block and Block Header encoders and decoders.
<a href="structlzma__block.html#details">More...</a></p>
<p><code>#include <block.h></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ac3936a5b0ec3f9b8f9c7ad68e7d149a5"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#ac3936a5b0ec3f9b8f9c7ad68e7d149a5">version</a></td></tr>
<tr class="memdesc:ac3936a5b0ec3f9b8f9c7ad68e7d149a5"><td class="mdescLeft"> </td><td class="mdescRight">Block format version. <a href="#ac3936a5b0ec3f9b8f9c7ad68e7d149a5">More...</a><br /></td></tr>
<tr class="separator:ac3936a5b0ec3f9b8f9c7ad68e7d149a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6689c4f7524b2c05772a2d6151138610"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a6689c4f7524b2c05772a2d6151138610">header_size</a></td></tr>
<tr class="memdesc:a6689c4f7524b2c05772a2d6151138610"><td class="mdescLeft"> </td><td class="mdescRight">Size of the Block Header field. <a href="#a6689c4f7524b2c05772a2d6151138610">More...</a><br /></td></tr>
<tr class="separator:a6689c4f7524b2c05772a2d6151138610"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80cd9d3025991db4a476ce7588f853e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a80cd9d3025991db4a476ce7588f853e6">check</a></td></tr>
<tr class="memdesc:a80cd9d3025991db4a476ce7588f853e6"><td class="mdescLeft"> </td><td class="mdescRight">Type of integrity Check. <a href="#a80cd9d3025991db4a476ce7588f853e6">More...</a><br /></td></tr>
<tr class="separator:a80cd9d3025991db4a476ce7588f853e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8383d489c9ffea8af390669a105c74e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a8383d489c9ffea8af390669a105c74e5">compressed_size</a></td></tr>
<tr class="memdesc:a8383d489c9ffea8af390669a105c74e5"><td class="mdescLeft"> </td><td class="mdescRight">Size of the Compressed Data in bytes. <a href="#a8383d489c9ffea8af390669a105c74e5">More...</a><br /></td></tr>
<tr class="separator:a8383d489c9ffea8af390669a105c74e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17362d38d1946dd16a9686557ec19a94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a17362d38d1946dd16a9686557ec19a94">uncompressed_size</a></td></tr>
<tr class="memdesc:a17362d38d1946dd16a9686557ec19a94"><td class="mdescLeft"> </td><td class="mdescRight">Uncompressed Size in bytes. <a href="#a17362d38d1946dd16a9686557ec19a94">More...</a><br /></td></tr>
<tr class="separator:a17362d38d1946dd16a9686557ec19a94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5900e517e6e0a473a3184074ae7defd1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structlzma__filter.html">lzma_filter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a5900e517e6e0a473a3184074ae7defd1">filters</a></td></tr>
<tr class="memdesc:a5900e517e6e0a473a3184074ae7defd1"><td class="mdescLeft"> </td><td class="mdescRight">Array of filters. <a href="#a5900e517e6e0a473a3184074ae7defd1">More...</a><br /></td></tr>
<tr class="separator:a5900e517e6e0a473a3184074ae7defd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a25e9bf1bb1699017694b18ca24f965d2"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a25e9bf1bb1699017694b18ca24f965d2">raw_check</a> [<a class="el" href="api_2lzma_2check_8h.html#a379e931cf86351ab1d97896cda9abbe0">LZMA_CHECK_SIZE_MAX</a>]</td></tr>
<tr class="memdesc:a25e9bf1bb1699017694b18ca24f965d2"><td class="mdescLeft"> </td><td class="mdescRight">Raw value stored in the Check field. <a href="#a25e9bf1bb1699017694b18ca24f965d2">More...</a><br /></td></tr>
<tr class="separator:a25e9bf1bb1699017694b18ca24f965d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac93263d0c9c3791a62c66b00b5163192"><td class="memItemLeft" align="right" valign="top"><a id="ac93263d0c9c3791a62c66b00b5163192"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr1</b></td></tr>
<tr class="separator:ac93263d0c9c3791a62c66b00b5163192"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12a6e26045014564160b7b11dde3a4de"><td class="memItemLeft" align="right" valign="top"><a id="a12a6e26045014564160b7b11dde3a4de"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr2</b></td></tr>
<tr class="separator:a12a6e26045014564160b7b11dde3a4de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a93f4cdeffad3bd54f8a29a5628bc0354"><td class="memItemLeft" align="right" valign="top"><a id="a93f4cdeffad3bd54f8a29a5628bc0354"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr3</b></td></tr>
<tr class="separator:a93f4cdeffad3bd54f8a29a5628bc0354"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aefd3a82a6bb42d584db8e271c3d8e7e5"><td class="memItemLeft" align="right" valign="top"><a id="aefd3a82a6bb42d584db8e271c3d8e7e5"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><b>reserved_int1</b></td></tr>
<tr class="separator:aefd3a82a6bb42d584db8e271c3d8e7e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56a55fcddfb20c8f67637f92390ccc84"><td class="memItemLeft" align="right" valign="top"><a id="a56a55fcddfb20c8f67637f92390ccc84"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><b>reserved_int2</b></td></tr>
<tr class="separator:a56a55fcddfb20c8f67637f92390ccc84"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f942073a3fd4ecb4b6688b31eab83e4"><td class="memItemLeft" align="right" valign="top"><a id="a8f942073a3fd4ecb4b6688b31eab83e4"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int3</b></td></tr>
<tr class="separator:a8f942073a3fd4ecb4b6688b31eab83e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9302e7f7bc7b469754e4cd70060c36d8"><td class="memItemLeft" align="right" valign="top"><a id="a9302e7f7bc7b469754e4cd70060c36d8"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int4</b></td></tr>
<tr class="separator:a9302e7f7bc7b469754e4cd70060c36d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a82b8fdcc19bfb2c7c85c370704d2a1"><td class="memItemLeft" align="right" valign="top"><a id="a7a82b8fdcc19bfb2c7c85c370704d2a1"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int5</b></td></tr>
<tr class="separator:a7a82b8fdcc19bfb2c7c85c370704d2a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cd27e168bc50e048a5651e2349db9e9"><td class="memItemLeft" align="right" valign="top"><a id="a0cd27e168bc50e048a5651e2349db9e9"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int6</b></td></tr>
<tr class="separator:a0cd27e168bc50e048a5651e2349db9e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada5cf837f1b9e33957b1714220093592"><td class="memItemLeft" align="right" valign="top"><a id="ada5cf837f1b9e33957b1714220093592"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int7</b></td></tr>
<tr class="separator:ada5cf837f1b9e33957b1714220093592"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39a042a40f749910bab479f81ee58a36"><td class="memItemLeft" align="right" valign="top"><a id="a39a042a40f749910bab479f81ee58a36"></a>
<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><b>reserved_int8</b></td></tr>
<tr class="separator:a39a042a40f749910bab479f81ee58a36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9584798ce37a2a28fbc37cb5802c5e24"><td class="memItemLeft" align="right" valign="top"><a id="a9584798ce37a2a28fbc37cb5802c5e24"></a>
<a class="el" href="base_8h.html#a05805a07754b2aa22f7d443eb7ece41a">lzma_reserved_enum</a> </td><td class="memItemRight" valign="bottom"><b>reserved_enum1</b></td></tr>
<tr class="separator:a9584798ce37a2a28fbc37cb5802c5e24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1551e1b1a0077d8d5017534c408418b"><td class="memItemLeft" align="right" valign="top"><a id="aa1551e1b1a0077d8d5017534c408418b"></a>
<a class="el" href="base_8h.html#a05805a07754b2aa22f7d443eb7ece41a">lzma_reserved_enum</a> </td><td class="memItemRight" valign="bottom"><b>reserved_enum2</b></td></tr>
<tr class="separator:aa1551e1b1a0077d8d5017534c408418b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f91e3e1eff8e16704adc98f8b8247cf"><td class="memItemLeft" align="right" valign="top"><a id="a4f91e3e1eff8e16704adc98f8b8247cf"></a>
<a class="el" href="base_8h.html#a05805a07754b2aa22f7d443eb7ece41a">lzma_reserved_enum</a> </td><td class="memItemRight" valign="bottom"><b>reserved_enum3</b></td></tr>
<tr class="separator:a4f91e3e1eff8e16704adc98f8b8247cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8743231e0878e72d925f2b316d96c165"><td class="memItemLeft" align="right" valign="top"><a id="a8743231e0878e72d925f2b316d96c165"></a>
<a class="el" href="base_8h.html#a05805a07754b2aa22f7d443eb7ece41a">lzma_reserved_enum</a> </td><td class="memItemRight" valign="bottom"><b>reserved_enum4</b></td></tr>
<tr class="separator:a8743231e0878e72d925f2b316d96c165"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a516ac9cc63bc1a4fadd9fbfc189a206b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__block.html#a516ac9cc63bc1a4fadd9fbfc189a206b">ignore_check</a></td></tr>
<tr class="memdesc:a516ac9cc63bc1a4fadd9fbfc189a206b"><td class="mdescLeft"> </td><td class="mdescRight">A flag to Block decoder to not verify the Check field. <a href="#a516ac9cc63bc1a4fadd9fbfc189a206b">More...</a><br /></td></tr>
<tr class="separator:a516ac9cc63bc1a4fadd9fbfc189a206b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d7e3982f63e2b2983449e0f303858c1"><td class="memItemLeft" align="right" valign="top"><a id="a6d7e3982f63e2b2983449e0f303858c1"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool2</b></td></tr>
<tr class="separator:a6d7e3982f63e2b2983449e0f303858c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc7ef0a795db3a819f8af42859e0b505"><td class="memItemLeft" align="right" valign="top"><a id="afc7ef0a795db3a819f8af42859e0b505"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool3</b></td></tr>
<tr class="separator:afc7ef0a795db3a819f8af42859e0b505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa801287f73f755d1c3e0c994449a0f95"><td class="memItemLeft" align="right" valign="top"><a id="aa801287f73f755d1c3e0c994449a0f95"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool4</b></td></tr>
<tr class="separator:aa801287f73f755d1c3e0c994449a0f95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0e4cce2df722794f0cb27a54360f60e"><td class="memItemLeft" align="right" valign="top"><a id="af0e4cce2df722794f0cb27a54360f60e"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool5</b></td></tr>
<tr class="separator:af0e4cce2df722794f0cb27a54360f60e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fba278ab21382b49ea67f1c99455837"><td class="memItemLeft" align="right" valign="top"><a id="a6fba278ab21382b49ea67f1c99455837"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool6</b></td></tr>
<tr class="separator:a6fba278ab21382b49ea67f1c99455837"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a51824da503cbbb61393ba0b4ceb1a113"><td class="memItemLeft" align="right" valign="top"><a id="a51824da503cbbb61393ba0b4ceb1a113"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool7</b></td></tr>
<tr class="separator:a51824da503cbbb61393ba0b4ceb1a113"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae344e512fc8d1cc4adfecbab081896bf"><td class="memItemLeft" align="right" valign="top"><a id="ae344e512fc8d1cc4adfecbab081896bf"></a>
<a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><b>reserved_bool8</b></td></tr>
<tr class="separator:ae344e512fc8d1cc4adfecbab081896bf"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Options for the Block and Block Header encoders and decoders. </p>
<p>Different Block handling functions use different parts of this structure. Some read some members, other functions write, and some do both. Only the members listed for reading need to be initialized when the specified functions are called. The members marked for writing will be assigned new values at some point either by calling the given function or by later calls to <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957" title="Encode or decode data. ">lzma_code()</a>. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="ac3936a5b0ec3f9b8f9c7ad68e7d149a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3936a5b0ec3f9b8f9c7ad68e7d149a5">§ </a></span>version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lzma_block::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block format version. </p>
<p>To prevent API and ABI breakages when new features are needed, a version number is used to indicate which fields in this structure are in use:</p><ul>
<li>liblzma >= 5.0.0: version = 0 is supported.</li>
<li>liblzma >= 5.1.4beta: Support for version = 1 was added, which adds the ignore_check field.</li>
</ul>
<p>If version is greater than one, most Block related functions will return LZMA_OPTIONS_ERROR (<a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a> works with any version value).</p>
<p>Read by:</p><ul>
<li>All functions that take pointer to <a class="el" href="structlzma__block.html" title="Options for the Block and Block Header encoders and decoders. ">lzma_block</a> as argument, including <a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a>.</li>
</ul>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a> </li>
</ul>
</div>
</div>
<a id="a6689c4f7524b2c05772a2d6151138610"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6689c4f7524b2c05772a2d6151138610">§ </a></span>header_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t lzma_block::header_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the Block Header field. </p>
<p>This is always a multiple of four.</p>
<p>Read by:</p><ul>
<li><a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a></li>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a></li>
<li><a class="el" href="block_8h.html#a6c3e102d76db06a07126a569abc6e2bc" title="Validate and set Compressed Size according to Unpadded Size. ">lzma_block_compressed_size()</a></li>
<li><a class="el" href="block_8h.html#a412d5605280fa29befae1b89e344bf30" title="Calculate Unpadded Size. ">lzma_block_unpadded_size()</a></li>
<li><a class="el" href="block_8h.html#a694424f9dfdd5151e01debac1c501fa9" title="Calculate the total encoded size of a Block. ">lzma_block_total_size()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a></li>
</ul>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a> </li>
</ul>
</div>
</div>
<a id="a80cd9d3025991db4a476ce7588f853e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80cd9d3025991db4a476ce7588f853e6">§ </a></span>check</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="api_2lzma_2check_8h.html#a0a6100c719ac9aa49be3fdf7519e8c3f">lzma_check</a> lzma_block::check</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of integrity Check. </p>
<p>The Check ID is not stored into the Block Header, thus its value must be provided also when decoding.</p>
<p>Read by:</p><ul>
<li><a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a></li>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a></li>
<li><a class="el" href="block_8h.html#a6c3e102d76db06a07126a569abc6e2bc" title="Validate and set Compressed Size according to Unpadded Size. ">lzma_block_compressed_size()</a></li>
<li><a class="el" href="block_8h.html#a412d5605280fa29befae1b89e344bf30" title="Calculate Unpadded Size. ">lzma_block_unpadded_size()</a></li>
<li><a class="el" href="block_8h.html#a694424f9dfdd5151e01debac1c501fa9" title="Calculate the total encoded size of a Block. ">lzma_block_total_size()</a></li>
<li><a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a> </li>
</ul>
</div>
</div>
<a id="a8383d489c9ffea8af390669a105c74e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8383d489c9ffea8af390669a105c74e5">§ </a></span>compressed_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> lzma_block::compressed_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the Compressed Data in bytes. </p>
<p>Encoding: If this is not LZMA_VLI_UNKNOWN, Block Header encoder will store this value to the Block Header. Block encoder doesn't care about this value, but will set it once the encoding has been finished.</p>
<p>Decoding: If this is not LZMA_VLI_UNKNOWN, Block decoder will verify that the size of the Compressed Data field matches compressed_size.</p>
<p>Usually you don't know this value when encoding in streamed mode, and thus cannot write this field into the Block Header.</p>
<p>In non-streamed mode you can reserve space for this field before encoding the actual Block. After encoding the data, finish the Block by encoding the Block Header. Steps in detail:</p>
<ul>
<li>Set compressed_size to some big enough value. If you don't know better, use LZMA_VLI_MAX, but remember that bigger values take more space in Block Header.</li>
<li>Call <a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a> to see how much space you need to reserve for the Block Header.</li>
<li>Encode the Block using <a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a> and <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957" title="Encode or decode data. ">lzma_code()</a>. It sets compressed_size to the correct value.</li>
<li>Use <a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a> to encode the Block Header. Because space was reserved in the first step, you don't need to call <a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a> anymore, because due to reserving, header_size has to be big enough. If it is "too big", <a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a> will add enough Header Padding to make Block Header to match the size specified by header_size.</li>
</ul>
<p>Read by:</p><ul>
<li><a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a></li>
<li><a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a></li>
<li><a class="el" href="block_8h.html#a6c3e102d76db06a07126a569abc6e2bc" title="Validate and set Compressed Size according to Unpadded Size. ">lzma_block_compressed_size()</a></li>
<li><a class="el" href="block_8h.html#a412d5605280fa29befae1b89e344bf30" title="Calculate Unpadded Size. ">lzma_block_unpadded_size()</a></li>
<li><a class="el" href="block_8h.html#a694424f9dfdd5151e01debac1c501fa9" title="Calculate the total encoded size of a Block. ">lzma_block_total_size()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a></li>
</ul>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a></li>
<li><a class="el" href="block_8h.html#a6c3e102d76db06a07126a569abc6e2bc" title="Validate and set Compressed Size according to Unpadded Size. ">lzma_block_compressed_size()</a></li>
<li><a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a> </li>
</ul>
</div>
</div>
<a id="a17362d38d1946dd16a9686557ec19a94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17362d38d1946dd16a9686557ec19a94">§ </a></span>uncompressed_size</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> lzma_block::uncompressed_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Uncompressed Size in bytes. </p>
<p>This is handled very similarly to compressed_size above.</p>
<p>uncompressed_size is needed by fewer functions than compressed_size. This is because uncompressed_size isn't needed to validate that Block stays within proper limits.</p>
<p>Read by:</p><ul>
<li><a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a></li>
<li><a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a></li>
</ul>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a></li>
<li><a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a> </li>
</ul>
</div>
</div>
<a id="a5900e517e6e0a473a3184074ae7defd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5900e517e6e0a473a3184074ae7defd1">§ </a></span>filters</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structlzma__filter.html">lzma_filter</a>* lzma_block::filters</td>
</tr>
</table>
</div><div class="memdoc">
<p>Array of filters. </p>
<p>There can be 1-4 filters. The end of the array is marked with .id = LZMA_VLI_UNKNOWN.</p>
<p>Read by:</p><ul>
<li><a class="el" href="block_8h.html#ae9b47abc872d0b02c2da9d3fa5a7dacd" title="Calculate Block Header Size. ">lzma_block_header_size()</a></li>
<li><a class="el" href="block_8h.html#a0eedbd6331d5708ea963260e6f2a92d0" title="Encode Block Header. ">lzma_block_header_encode()</a></li>
<li><a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a></li>
</ul>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a>: Note that this does NOT free() the old filter options structures. All unused filters[] will have .id == LZMA_VLI_UNKNOWN and .options == NULL. If decoding fails, all filters[] are guaranteed to be LZMA_VLI_UNKNOWN and NULL.</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>Because of the array is terminated with .id = LZMA_VLI_UNKNOWN, the actual array must have LZMA_FILTERS_MAX + 1 members or the Block Header decoder will overflow the buffer. </dd></dl>
</div>
</div>
<a id="a25e9bf1bb1699017694b18ca24f965d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25e9bf1bb1699017694b18ca24f965d2">§ </a></span>raw_check</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t lzma_block::raw_check[<a class="el" href="api_2lzma_2check_8h.html#a379e931cf86351ab1d97896cda9abbe0">LZMA_CHECK_SIZE_MAX</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Raw value stored in the Check field. </p>
<p>After successful coding, the first lzma_check_size(check) bytes of this array contain the raw value stored in the Check field.</p>
<p>Note that CRC32 and CRC64 are stored in little endian byte order. Take it into account if you display the Check values to the user.</p>
<p>Written by:</p><ul>
<li><a class="el" href="block_8h.html#a2218a49025a0b44f9a6f9d6d24359359" title="Initialize .xz Block encoder. ">lzma_block_encoder()</a></li>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#af415fa5130ab64e8760e9c39e856fa54" title="Single-call .xz Block encoder. ">lzma_block_buffer_encode()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a> </li>
</ul>
</div>
</div>
<a id="a516ac9cc63bc1a4fadd9fbfc189a206b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a516ac9cc63bc1a4fadd9fbfc189a206b">§ </a></span>ignore_check</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> lzma_block::ignore_check</td>
</tr>
</table>
</div><div class="memdoc">
<p>A flag to Block decoder to not verify the Check field. </p>
<p>This field is supported by liblzma >= 5.1.4beta if .version >= 1.</p>
<p>If this is set to true, the integrity check won't be calculated and verified. Unless you know what you are doing, you should leave this to false. (A reason to set this to true is when the file integrity is verified externally anyway and you want to speed up the decompression, which matters mostly when using SHA-256 as the integrity check.)</p>
<p>If .version >= 1, read by:</p><ul>
<li><a class="el" href="block_8h.html#aa92c73b2a228efe921fa2376aa7adc92" title="Initialize .xz Block decoder. ">lzma_block_decoder()</a></li>
<li><a class="el" href="block_8h.html#a0c6eb869d91b08f68648b1aa7a32ee9f" title="Single-call .xz Block decoder. ">lzma_block_buffer_decode()</a></li>
</ul>
<p>Written by (.version is ignored):</p><ul>
<li><a class="el" href="block_8h.html#a7f5487c21a7b36a8bd17be36074d43c9" title="Decode Block Header. ">lzma_block_header_decode()</a> always sets this to false </li>
</ul>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>liblzma/api/lzma/<a class="el" href="block_8h.html">block.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.12
</small></address>
</body>
</html>
|