/usr/share/doc/liblzma-doc/html/structlzma__stream.html is in liblzma-doc 5.2.2-1.3.
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 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: lzma_stream 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.13 -->
<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_stream Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Passing data to and from liblzma.
<a href="structlzma__stream.html#details">More...</a></p>
<p><code>#include <base.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:a72fdc738c793f07a5c29715aa57802cf"><td class="memItemLeft" align="right" valign="top">const uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a72fdc738c793f07a5c29715aa57802cf">next_in</a></td></tr>
<tr class="separator:a72fdc738c793f07a5c29715aa57802cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb680ecea31910cbda1d7a6ad4f191c0"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#abb680ecea31910cbda1d7a6ad4f191c0">avail_in</a></td></tr>
<tr class="separator:abb680ecea31910cbda1d7a6ad4f191c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a411e1755d6185756caefabc3932c7b"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a1a411e1755d6185756caefabc3932c7b">total_in</a></td></tr>
<tr class="separator:a1a411e1755d6185756caefabc3932c7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14ee64ed636ddcb775edf87e2b9f42ec"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a14ee64ed636ddcb775edf87e2b9f42ec">next_out</a></td></tr>
<tr class="separator:a14ee64ed636ddcb775edf87e2b9f42ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ff28ea4e39148723c19f59811627904"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a5ff28ea4e39148723c19f59811627904">avail_out</a></td></tr>
<tr class="separator:a5ff28ea4e39148723c19f59811627904"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80d703ffdfd7661e344fe7b61ff737fa"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a80d703ffdfd7661e344fe7b61ff737fa">total_out</a></td></tr>
<tr class="separator:a80d703ffdfd7661e344fe7b61ff737fa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4eb2f3e87e32cc4bea613898b0bd353f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a4eb2f3e87e32cc4bea613898b0bd353f">allocator</a></td></tr>
<tr class="memdesc:a4eb2f3e87e32cc4bea613898b0bd353f"><td class="mdescLeft"> </td><td class="mdescRight">Custom memory allocation functions. <a href="#a4eb2f3e87e32cc4bea613898b0bd353f">More...</a><br /></td></tr>
<tr class="separator:a4eb2f3e87e32cc4bea613898b0bd353f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a209da54c2fb5dea40ad011c8408300d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#ab1a60127c640135687a5bcc232cec906">lzma_internal</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__stream.html#a209da54c2fb5dea40ad011c8408300d0">internal</a></td></tr>
<tr class="separator:a209da54c2fb5dea40ad011c8408300d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81fcec9c9ce275ff1fedcb9bab15a7f5"><td class="memItemLeft" align="right" valign="top"><a id="a81fcec9c9ce275ff1fedcb9bab15a7f5"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr1</b></td></tr>
<tr class="separator:a81fcec9c9ce275ff1fedcb9bab15a7f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7d7fd72ae7155eff6701c9f9ce9a6a7"><td class="memItemLeft" align="right" valign="top"><a id="ab7d7fd72ae7155eff6701c9f9ce9a6a7"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr2</b></td></tr>
<tr class="separator:ab7d7fd72ae7155eff6701c9f9ce9a6a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09649803b9d487974c731b144819799a"><td class="memItemLeft" align="right" valign="top"><a id="a09649803b9d487974c731b144819799a"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr3</b></td></tr>
<tr class="separator:a09649803b9d487974c731b144819799a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade4733d119d61b363cf3242809e2c42a"><td class="memItemLeft" align="right" valign="top"><a id="ade4733d119d61b363cf3242809e2c42a"></a>
void * </td><td class="memItemRight" valign="bottom"><b>reserved_ptr4</b></td></tr>
<tr class="separator:ade4733d119d61b363cf3242809e2c42a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06383fc1c539abcbe7e9a4ef72516bae"><td class="memItemLeft" align="right" valign="top"><a id="a06383fc1c539abcbe7e9a4ef72516bae"></a>
uint64_t </td><td class="memItemRight" valign="bottom"><b>reserved_int1</b></td></tr>
<tr class="separator:a06383fc1c539abcbe7e9a4ef72516bae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5ceace43e0563a9e0f6f4c41efaa798"><td class="memItemLeft" align="right" valign="top"><a id="ae5ceace43e0563a9e0f6f4c41efaa798"></a>
uint64_t </td><td class="memItemRight" valign="bottom"><b>reserved_int2</b></td></tr>
<tr class="separator:ae5ceace43e0563a9e0f6f4c41efaa798"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20d5b98e6fa087a6b946712129df0397"><td class="memItemLeft" align="right" valign="top"><a id="a20d5b98e6fa087a6b946712129df0397"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>reserved_int3</b></td></tr>
<tr class="separator:a20d5b98e6fa087a6b946712129df0397"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae08c3bd899a7d80869a70c3504f3b856"><td class="memItemLeft" align="right" valign="top"><a id="ae08c3bd899a7d80869a70c3504f3b856"></a>
size_t </td><td class="memItemRight" valign="bottom"><b>reserved_int4</b></td></tr>
<tr class="separator:ae08c3bd899a7d80869a70c3504f3b856"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab00d03009d667004568ad7391fd1c857"><td class="memItemLeft" align="right" valign="top"><a id="ab00d03009d667004568ad7391fd1c857"></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:ab00d03009d667004568ad7391fd1c857"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a914a4a094aa97b0c06f1ba9a692dde85"><td class="memItemLeft" align="right" valign="top"><a id="a914a4a094aa97b0c06f1ba9a692dde85"></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:a914a4a094aa97b0c06f1ba9a692dde85"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Passing data to and from liblzma. </p>
<p>The <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> structure is used for</p><ul>
<li>passing pointers to input and output buffers to liblzma;</li>
<li>defining custom memory hander functions; and</li>
<li>holding a pointer to coder-specific internal data structures.</li>
</ul>
<p>Typical usage:</p>
<ul>
<li>After allocating <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> (on stack or with malloc()), it must be initialized to LZMA_STREAM_INIT (see LZMA_STREAM_INIT for details).</li>
<li>Initialize a coder to the <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a>, for example by using <a class="el" href="container_8h.html#acbdad999c544872f0f5d242f0d1a4ed4" title="Initialize .xz Stream encoder using a preset number. ">lzma_easy_encoder()</a> or <a class="el" href="container_8h.html#a21cbebf2771617bb1e956385cfb353e3" title="Decode .xz Streams and .lzma files with autodetection. ">lzma_auto_decoder()</a>. Some notes:<ul>
<li>In contrast to zlib, strm->next_in and strm->next_out are ignored by all initialization functions, thus it is safe to not initialize them yet.</li>
<li>The initialization functions always set strm->total_in and strm->total_out to zero.</li>
<li>If the initialization function fails, no memory is left allocated that would require freeing with <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308" title="Free memory allocated for the coder data structures. ">lzma_end()</a> even if some memory was associated with the <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> structure when the initialization function was called.</li>
</ul>
</li>
<li>Use <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957" title="Encode or decode data. ">lzma_code()</a> to do the actual work.</li>
<li>Once the coding has been finished, the existing <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> can be reused. It is OK to reuse <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> with different initialization function without calling <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308" title="Free memory allocated for the coder data structures. ">lzma_end()</a> first. Old allocations are automatically freed.</li>
<li>Finally, use <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308" title="Free memory allocated for the coder data structures. ">lzma_end()</a> to free the allocated memory. <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308" title="Free memory allocated for the coder data structures. ">lzma_end()</a> never frees the <a class="el" href="structlzma__stream.html" title="Passing data to and from liblzma. ">lzma_stream</a> structure itself.</li>
</ul>
<p>Application may modify the values of total_in and total_out as it wants. They are updated by liblzma to match the amount of data read and written but aren't used for anything else except as a possible return values from <a class="el" href="base_8h.html#ab6447cd68eeecbd6b88f21daeb8ce751" title="Get progress information. ">lzma_get_progress()</a>. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a72fdc738c793f07a5c29715aa57802cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72fdc738c793f07a5c29715aa57802cf">◆ </a></span>next_in</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const uint8_t* lzma_stream::next_in</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the next input byte. </p>
<p class="reference">Referenced by <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957">lzma_code()</a>.</p>
</div>
</div>
<a id="abb680ecea31910cbda1d7a6ad4f191c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb680ecea31910cbda1d7a6ad4f191c0">◆ </a></span>avail_in</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lzma_stream::avail_in</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of available input bytes in next_in. </p>
<p class="reference">Referenced by <a class="el" href="coder_8c.html#ae31acd560ee4d35b7bd0d1bdc94fde0a">coder_passthru()</a>, <a class="el" href="coder_8c.html#a15b6ce144220e53107c642b3baefe9bc">is_format_lzma()</a>, <a class="el" href="coder_8c.html#adfb624a2250710ee841a43e793e1d863">is_format_xz()</a>, and <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957">lzma_code()</a>.</p>
</div>
</div>
<a id="a1a411e1755d6185756caefabc3932c7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a411e1755d6185756caefabc3932c7b">◆ </a></span>total_in</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t lzma_stream::total_in</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of bytes read by liblzma. </p>
<p class="reference">Referenced by <a class="el" href="coder_8c.html#ae31acd560ee4d35b7bd0d1bdc94fde0a">coder_passthru()</a>, and <a class="el" href="base_8h.html#ab6447cd68eeecbd6b88f21daeb8ce751">lzma_get_progress()</a>.</p>
</div>
</div>
<a id="a14ee64ed636ddcb775edf87e2b9f42ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14ee64ed636ddcb775edf87e2b9f42ec">◆ </a></span>next_out</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* lzma_stream::next_out</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the next output position. </p>
<p class="reference">Referenced by <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957">lzma_code()</a>.</p>
</div>
</div>
<a id="a5ff28ea4e39148723c19f59811627904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ff28ea4e39148723c19f59811627904">◆ </a></span>avail_out</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t lzma_stream::avail_out</td>
</tr>
</table>
</div><div class="memdoc">
<p>Amount of free space in next_out. </p>
<p class="reference">Referenced by <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957">lzma_code()</a>.</p>
</div>
</div>
<a id="a80d703ffdfd7661e344fe7b61ff737fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80d703ffdfd7661e344fe7b61ff737fa">◆ </a></span>total_out</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t lzma_stream::total_out</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of bytes written by liblzma. </p>
<p class="reference">Referenced by <a class="el" href="coder_8c.html#ae31acd560ee4d35b7bd0d1bdc94fde0a">coder_passthru()</a>, and <a class="el" href="base_8h.html#ab6447cd68eeecbd6b88f21daeb8ce751">lzma_get_progress()</a>.</p>
</div>
</div>
<a id="a4eb2f3e87e32cc4bea613898b0bd353f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4eb2f3e87e32cc4bea613898b0bd353f">◆ </a></span>allocator</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structlzma__allocator.html">lzma_allocator</a>* lzma_stream::allocator</td>
</tr>
</table>
</div><div class="memdoc">
<p>Custom memory allocation functions. </p>
<p>In most cases this is NULL which makes liblzma use the standard malloc() and free().</p>
<dl class="section note"><dt>Note</dt><dd>In 5.0.x this is not a const pointer. </dd></dl>
<p class="reference">Referenced by <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308">lzma_end()</a>, and <a class="el" href="common_8h.html#a83455498798efe8409f8b9f11a77b2aa">lzma_strm_init()</a>.</p>
</div>
</div>
<a id="a209da54c2fb5dea40ad011c8408300d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a209da54c2fb5dea40ad011c8408300d0">◆ </a></span>internal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#ab1a60127c640135687a5bcc232cec906">lzma_internal</a>* lzma_stream::internal</td>
</tr>
</table>
</div><div class="memdoc">
<p>Internal state is not visible to applications. </p>
<p class="reference">Referenced by <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957">lzma_code()</a>, <a class="el" href="base_8h.html#a854ff37464ae1225febf14db1af43308">lzma_end()</a>, <a class="el" href="filter__encoder_8c.html#adcde5a9917d1ca033f6c1cc35c9be4fc">lzma_filters_update()</a>, <a class="el" href="api_2lzma_2check_8h.html#a8d7c3ffabfd024485f03fa209536c746">lzma_get_check()</a>, <a class="el" href="base_8h.html#ab6447cd68eeecbd6b88f21daeb8ce751">lzma_get_progress()</a>, <a class="el" href="base_8h.html#ac871bc2ead5d482c6d6b3d51bfec365c">lzma_memlimit_get()</a>, <a class="el" href="base_8h.html#afc49d4cf75b73128a167df3407505f7b">lzma_memlimit_set()</a>, <a class="el" href="base_8h.html#a418b210cf206782a73cd9de7dc27f670">lzma_memusage()</a>, <a class="el" href="common_8h.html#ae000b50b68fda291c15fb61cde902dcc">lzma_next_end()</a>, and <a class="el" href="common_8h.html#a83455498798efe8409f8b9f11a77b2aa">lzma_strm_init()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>liblzma/api/lzma/<a class="el" href="base_8h.html">base.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.13
</small></address>
</body>
</html>
|