• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>basic_flat_buffer::consume</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__basic_flat_buffer.html" title="basic_flat_buffer">
9<link rel="prev" href="commit.html" title="basic_flat_buffer::commit">
10<link rel="next" href="../boost__beast__basic_multi_buffer.html" title="basic_multi_buffer">
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="commit.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_flat_buffer.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__basic_multi_buffer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="beast.ref.boost__beast__basic_flat_buffer.consume"></a><a class="link" href="consume.html" title="basic_flat_buffer::consume">basic_flat_buffer::consume</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057549015008"></a>
31        </p>
32<p>
33          Remove bytes from beginning of the readable bytes.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__basic_flat_buffer.consume.h0"></a>
37          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.consume.synopsis"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__basic_flat_buffer.consume.synopsis">Synopsis</a>
38        </h6>
39<pre class="programlisting"><span class="keyword">void</span>
40<span class="identifier">consume</span><span class="special">(</span>
41    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">);</span>
42</pre>
43<h6>
44<a name="beast.ref.boost__beast__basic_flat_buffer.consume.h1"></a>
45          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.consume.description"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__basic_flat_buffer.consume.description">Description</a>
46        </h6>
47<p>
48          Removes n bytes from the beginning of the readable bytes. All buffers sequences
49          previously obtained using <a class="link" href="data/overload1.html" title="basic_flat_buffer::data (1 of 2 overloads)"><code class="computeroutput"><span class="identifier">data</span></code></a> or <a class="link" href="prepare.html" title="basic_flat_buffer::prepare"><code class="computeroutput"><span class="identifier">prepare</span></code></a> become invalid.
50        </p>
51<h6>
52<a name="beast.ref.boost__beast__basic_flat_buffer.consume.h2"></a>
53          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.consume.parameters"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__basic_flat_buffer.consume.parameters">Parameters</a>
54        </h6>
55<div class="informaltable"><table class="table">
56<colgroup>
57<col>
58<col>
59</colgroup>
60<thead><tr>
61<th>
62                  <p>
63                    Name
64                  </p>
65                </th>
66<th>
67                  <p>
68                    Description
69                  </p>
70                </th>
71</tr></thead>
72<tbody><tr>
73<td>
74                  <p>
75                    <code class="computeroutput"><span class="identifier">n</span></code>
76                  </p>
77                </td>
78<td>
79                  <p>
80                    The number of bytes to remove. If this number is greater than
81                    the number of readable bytes, all readable bytes are removed.
82                  </p>
83                </td>
84</tr></tbody>
85</table></div>
86<h6>
87<a name="beast.ref.boost__beast__basic_flat_buffer.consume.h3"></a>
88          <span class="phrase"><a name="beast.ref.boost__beast__basic_flat_buffer.consume.exception_safety"></a></span><a class="link" href="consume.html#beast.ref.boost__beast__basic_flat_buffer.consume.exception_safety">Exception
89          Safety</a>
90        </h6>
91<p>
92          No-throw guarantee.
93        </p>
94</div>
95<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
96<td align="left"></td>
97<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
98      Falco<p>
99        Distributed under the Boost Software License, Version 1.0. (See accompanying
100        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>)
101      </p>
102</div></td>
103</tr></table>
104<hr>
105<div class="spirit-nav">
106<a accesskey="p" href="commit.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_flat_buffer.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__basic_multi_buffer.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
107</div>
108</body>
109</html>
110