• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>zlib::deflate_upper_bound</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="../ref.html" title="This Page Intentionally Left Blank 2/2">
9<link rel="prev" href="boost__beast__zlib__uInt.html" title="zlib::uInt">
10<link rel="next" href="../release_notes.html" title="Release Notes">
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__uInt.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="../release_notes.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__deflate_upper_bound"></a><a class="link" href="boost__beast__zlib__deflate_upper_bound.html" title="zlib::deflate_upper_bound">zlib::deflate_upper_bound</a>
28</h4></div></div></div>
29<p>
30        <a class="indexterm" name="idm46057501638848"></a>
31      </p>
32<p>
33        Returns the upper limit on the size of a compressed block.
34      </p>
35<h5>
36<a name="beast.ref.boost__beast__zlib__deflate_upper_bound.h0"></a>
37        <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_upper_bound.synopsis"></a></span><a class="link" href="boost__beast__zlib__deflate_upper_bound.html#beast.ref.boost__beast__zlib__deflate_upper_bound.synopsis">Synopsis</a>
38      </h5>
39<p>
40        Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/zlib/deflate_stream.hpp" target="_top">boost/beast/zlib/deflate_stream.hpp</a>&gt;</code>
41      </p>
42<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span>
43<span class="identifier">deflate_upper_bound</span><span class="special">(</span>
44    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes</span><span class="special">);</span>
45</pre>
46<h5>
47<a name="beast.ref.boost__beast__zlib__deflate_upper_bound.h1"></a>
48        <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_upper_bound.description"></a></span><a class="link" href="boost__beast__zlib__deflate_upper_bound.html#beast.ref.boost__beast__zlib__deflate_upper_bound.description">Description</a>
49      </h5>
50<p>
51        This function makes a conservative estimate of the maximum number of bytes
52        needed to store the result of compressing a block of data.
53      </p>
54<h5>
55<a name="beast.ref.boost__beast__zlib__deflate_upper_bound.h2"></a>
56        <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_upper_bound.parameters"></a></span><a class="link" href="boost__beast__zlib__deflate_upper_bound.html#beast.ref.boost__beast__zlib__deflate_upper_bound.parameters">Parameters</a>
57      </h5>
58<div class="informaltable"><table class="table">
59<colgroup>
60<col>
61<col>
62</colgroup>
63<thead><tr>
64<th>
65                <p>
66                  Name
67                </p>
68              </th>
69<th>
70                <p>
71                  Description
72                </p>
73              </th>
74</tr></thead>
75<tbody><tr>
76<td>
77                <p>
78                  <code class="computeroutput"><span class="identifier">bytes</span></code>
79                </p>
80              </td>
81<td>
82                <p>
83                  The size of the uncompressed data.
84                </p>
85              </td>
86</tr></tbody>
87</table></div>
88<h5>
89<a name="beast.ref.boost__beast__zlib__deflate_upper_bound.h3"></a>
90        <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_upper_bound.return_value"></a></span><a class="link" href="boost__beast__zlib__deflate_upper_bound.html#beast.ref.boost__beast__zlib__deflate_upper_bound.return_value">Return
91        Value</a>
92      </h5>
93<p>
94        The maximum number of resulting compressed bytes.
95      </p>
96</div>
97<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
98<td align="left"></td>
99<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
100      Falco<p>
101        Distributed under the Boost Software License, Version 1.0. (See accompanying
102        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>)
103      </p>
104</div></td>
105</tr></table>
106<hr>
107<div class="spirit-nav">
108<a accesskey="p" href="boost__beast__zlib__uInt.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="../release_notes.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
109</div>
110</body>
111</html>
112