3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>zlib::deflate_stream::prime</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 1. Boost.Beast">
8 <link rel="up" href="../boost__beast__zlib__deflate_stream.html" title="zlib::deflate_stream">
9 <link rel="prev" href="pending.html" title="zlib::deflate_stream::pending">
10 <link rel="next" href="reset.html" title="zlib::deflate_stream::reset">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="pending.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.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="reset.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="beast.ref.boost__beast__zlib__deflate_stream.prime"></a><a class="link" href="prime.html" title="zlib::deflate_stream::prime">zlib::deflate_stream::prime</a>
28 </h5></div></div></div>
30 <a class="indexterm" name="idm45873468723776"></a>
31 Insert bits into the compressed output stream.
34 <a name="beast.ref.boost__beast__zlib__deflate_stream.prime.h0"></a>
35 <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.prime.synopsis"></a></span><a class="link" href="prime.html#beast.ref.boost__beast__zlib__deflate_stream.prime.synopsis">Synopsis</a>
37 <pre class="programlisting"><span class="keyword">void</span>
38 <span class="identifier">prime</span><span class="special">(</span>
39 <span class="keyword">int</span> <span class="identifier">bits</span><span class="special">,</span>
40 <span class="keyword">int</span> <span class="identifier">value</span><span class="special">,</span>
41 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span>
44 <a name="beast.ref.boost__beast__zlib__deflate_stream.prime.h1"></a>
45 <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.prime.description"></a></span><a class="link" href="prime.html#beast.ref.boost__beast__zlib__deflate_stream.prime.description">Description</a>
48 This function inserts bits in the deflate output stream. The intent is
49 that this function is used to start off the deflate output with the bits
50 leftover from a previous deflate stream when appending to it. As such,
51 this function can only be used for raw deflate, and must be used before
52 the first <code class="computeroutput"><span class="identifier">write</span></code> call after
53 an initialization. <code class="computeroutput"><span class="identifier">bits</span></code>
54 must be less than or equal to 16, and that many of the least significant
55 bits of <code class="computeroutput"><span class="identifier">value</span></code> will be inserted
59 <a name="beast.ref.boost__beast__zlib__deflate_stream.prime.h2"></a>
60 <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.prime.return_value"></a></span><a class="link" href="prime.html#beast.ref.boost__beast__zlib__deflate_stream.prime.return_value">Return
64 <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">need_buffers</span></code> if there was not enough
65 room in the internal buffer to insert the bits.
68 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
69 <td align="left"></td>
70 <td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
72 Distributed under the Boost Software License, Version 1.0. (See accompanying
73 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>)
78 <div class="spirit-nav">
79 <a accesskey="p" href="pending.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.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="reset.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>