libs/beast/doc/html/beast/ref/boost__beast__zlib__error.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>zlib::error</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__zlib__deflate_upper_bound.html" title="zlib::deflate_upper_bound">
  10 <link rel="next" href="boost__beast__zlib__inflate_stream.html" title="zlib::inflate_stream">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="boost__beast__zlib__deflate_upper_bound.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__zlib__inflate_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__zlib__error"></a><a class="link" href="boost__beast__zlib__error.html" title="zlib::error">zlib::error</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873468387248"></a>
  31 Error codes returned by the deflate codecs.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__zlib__error.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__zlib__error.synopsis"></a></span><a class="link" href="boost__beast__zlib__error.html#beast.ref.boost__beast__zlib__error.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/zlib/error.hpp" target="_top">boost/beast/zlib/error.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">error</span>
  41 </pre>
  42 <p>
  43         <a class="indexterm" name="idm45873468379344"></a>
  44  <a class="indexterm" name="idm45873468378240"></a>
  45  <a class="indexterm" name="idm45873468377136"></a>
  46  <a class="indexterm" name="idm45873468376032"></a>
  47  <a class="indexterm" name="idm45873468374928"></a>
  48  <a class="indexterm" name="idm45873468373824"></a>
  49  <a class="indexterm" name="idm45873468372720"></a>
  50  <a class="indexterm" name="idm45873468371616"></a>
  51  <a class="indexterm" name="idm45873468370512"></a>
  52  <a class="indexterm" name="idm45873468369408"></a>
  53  <a class="indexterm" name="idm45873468368288"></a>
  54  <a class="indexterm" name="idm45873468367184"></a>
  55  <a class="indexterm" name="idm45873468366080"></a>
  56  <a class="indexterm" name="idm45873468364976"></a>
  57  <a class="indexterm" name="idm45873468363872"></a>
  58  <a class="indexterm" name="idm45873468362768"></a>
  59  <a class="indexterm" name="idm45873468361664"></a>
  60
  61       </p>
  62 <h5>
  63 <a name="beast.ref.boost__beast__zlib__error.h1"></a>
  64         <span class="phrase"><a name="beast.ref.boost__beast__zlib__error.values"></a></span><a class="link" href="boost__beast__zlib__error.html#beast.ref.boost__beast__zlib__error.values">Values</a>
  65       </h5>
  66 <div class="informaltable"><table class="table">
  67 <colgroup>
  68 <col>
  69 <col>
  70 </colgroup>
  71 <thead><tr>
  72 <th>
  73                 <p>
  74                   Name
  75                 </p>
  76               </th>
  77 <th>
  78                 <p>
  79                   Description
  80                 </p>
  81               </th>
  82 </tr></thead>
  83 <tbody>
  84 <tr>
  85 <td>
  86                 <p>
  87                   <code class="literal">need_buffers</code>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   Additional buffers are required.
  93                 </p>
  94                 <p>
  95                   This error indicates that one or both of the buffers provided buffers
  96                   do not have sufficient available bytes to make forward progress.
  97                 </p>
  98                 <p>
  99                   This does not always indicate a failure condition.
 100                 </p>
 101                 <p>
 102                   @note This is the same as <code class="computeroutput"><span class="identifier">Z_BUF_ERROR</span></code>
 103                   returned by ZLib.
 104                 </p>
 105               </td>
 106 </tr>
 107 <tr>
 108 <td>
 109                 <p>
 110                   <code class="literal">end_of_stream</code>
 111                 </p>
 112               </td>
 113 <td>
 114                 <p>
 115                   End of stream reached.
 116                 </p>
 117                 <p>
 118                   @note This is the same as <code class="computeroutput"><span class="identifier">Z_STREAM_END</span></code>
 119                   returned by ZLib.
 120                 </p>
 121               </td>
 122 </tr>
 123 <tr>
 124 <td>
 125                 <p>
 126                   <code class="literal">need_dict</code>
 127                 </p>
 128               </td>
 129 <td>
 130                 <p>
 131                   Preset dictionary required.
 132                 </p>
 133                 <p>
 134                   This error indicates that a preset dictionary was not provided
 135                   and is now needed at this point.
 136                 </p>
 137                 <p>
 138                   This does not always indicate a failure condition.
 139                 </p>
 140                 <p>
 141                   @note This is the same as <code class="computeroutput"><span class="identifier">Z_NEED_DICT</span></code>
 142                   returned by ZLib.
 143                 </p>
 144               </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                 <p>
 149                   <code class="literal">stream_error</code>
 150                 </p>
 151               </td>
 152 <td>
 153                 <p>
 154                   Invalid stream or parameters.
 155                 </p>
 156                 <p>
 157                   This error is returned when invalid parameters are passed, or the
 158                   operation being performed is not consistent with the state of the
 159                   stream. For example, attempting to write data when the end of stream
 160                   is already reached.
 161                 </p>
 162                 <p>
 163                   @note This is the same as <code class="computeroutput"><span class="identifier">Z_STREAM_ERROR</span></code>
 164                   returned by ZLib.
 165                 </p>
 166               </td>
 167 </tr>
 168 <tr>
 169 <td>
 170                 <p>
 171                   <code class="literal">invalid_block_type</code>
 172                 </p>
 173               </td>
 174 <td>
 175                 <p>
 176                   Invalid block type.
 177                 </p>
 178               </td>
 179 </tr>
 180 <tr>
 181 <td>
 182                 <p>
 183                   <code class="literal">invalid_stored_length</code>
 184                 </p>
 185               </td>
 186 <td>
 187                 <p>
 188                   Invalid stored block length.
 189                 </p>
 190               </td>
 191 </tr>
 192 <tr>
 193 <td>
 194                 <p>
 195                   <code class="literal">too_many_symbols</code>
 196                 </p>
 197               </td>
 198 <td>
 199                 <p>
 200                   Too many length or distance symbols.
 201                 </p>
 202               </td>
 203 </tr>
 204 <tr>
 205 <td>
 206                 <p>
 207                   <code class="literal">invalid_code_lengths</code>
 208                 </p>
 209               </td>
 210 <td>
 211                 <p>
 212                   Invalid code lengths.
 213                 </p>
 214               </td>
 215 </tr>
 216 <tr>
 217 <td>
 218                 <p>
 219                   <code class="literal">invalid_code_lenths</code>
 220                 </p>
 221               </td>
 222 <td>
 223               </td>
 224 </tr>
 225 <tr>
 226 <td>
 227                 <p>
 228                   <code class="literal">invalid_bit_length_repeat</code>
 229                 </p>
 230               </td>
 231 <td>
 232                 <p>
 233                   Invalid bit length repeat.
 234                 </p>
 235               </td>
 236 </tr>
 237 <tr>
 238 <td>
 239                 <p>
 240                   <code class="literal">missing_eob</code>
 241                 </p>
 242               </td>
 243 <td>
 244                 <p>
 245                   Missing end of block code.
 246                 </p>
 247               </td>
 248 </tr>
 249 <tr>
 250 <td>
 251                 <p>
 252                   <code class="literal">invalid_literal_length</code>
 253                 </p>
 254               </td>
 255 <td>
 256                 <p>
 257                   Invalid literal/length code.
 258                 </p>
 259               </td>
 260 </tr>
 261 <tr>
 262 <td>
 263                 <p>
 264                   <code class="literal">invalid_distance_code</code>
 265                 </p>
 266               </td>
 267 <td>
 268                 <p>
 269                   Invalid distance code.
 270                 </p>
 271               </td>
 272 </tr>
 273 <tr>
 274 <td>
 275                 <p>
 276                   <code class="literal">invalid_distance</code>
 277                 </p>
 278               </td>
 279 <td>
 280                 <p>
 281                   Invalid distance too far back.
 282                 </p>
 283               </td>
 284 </tr>
 285 <tr>
 286 <td>
 287                 <p>
 288                   <code class="literal">over_subscribed_length</code>
 289                 </p>
 290               </td>
 291 <td>
 292                 <p>
 293                   Over-subscribed length code.
 294                 </p>
 295               </td>
 296 </tr>
 297 <tr>
 298 <td>
 299                 <p>
 300                   <code class="literal">incomplete_length_set</code>
 301                 </p>
 302               </td>
 303 <td>
 304                 <p>
 305                   Incomplete length set.
 306                 </p>
 307               </td>
 308 </tr>
 309 <tr>
 310 <td>
 311                 <p>
 312                   <code class="literal">general</code>
 313                 </p>
 314               </td>
 315 <td>
 316                 <p>
 317                   general error
 318                 </p>
 319               </td>
 320 </tr>
 321 </tbody>
 322 </table></div>
 323 <h5>
 324 <a name="beast.ref.boost__beast__zlib__error.h2"></a>
 325         <span class="phrase"><a name="beast.ref.boost__beast__zlib__error.description"></a></span><a class="link" href="boost__beast__zlib__error.html#beast.ref.boost__beast__zlib__error.description">Description</a>
 326       </h5>
 327 <p>
 328         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/zlib.hpp" target="_top">boost/beast/zlib.hpp</a>&gt;</code>
 329       </p>
 330 </div>
 331 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 332 <td align="left"></td>
 333 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 334       Falco<p>
 335         Distributed under the Boost Software License, Version 1.0. (See accompanying
 336         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 337       </p>
 338 </div></td>
 339 </tr></table>
 340 <hr>
 341 <div class="spirit-nav">
 342 <a accesskey="p" href="boost__beast__zlib__deflate_upper_bound.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boost__beast__zlib__inflate_stream.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 343 </div>
 344 </body>
 345 </html>