mutable_buffer.html
7.07 KB
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
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>mutable_buffer</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="multiple_exceptions/what.html" title="multiple_exceptions::what">
<link rel="next" href="mutable_buffer/data.html" title="mutable_buffer::data">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="multiple_exceptions/what.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="mutable_buffer/data.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.mutable_buffer"></a><a class="link" href="mutable_buffer.html" title="mutable_buffer">mutable_buffer</a>
</h3></div></div></div>
<p>
Holds a buffer that can be modified.
</p>
<pre class="programlisting">class mutable_buffer
</pre>
<h5>
<a name="asio.reference.mutable_buffer.h0"></a>
<span><a name="asio.reference.mutable_buffer.member_functions"></a></span><a class="link" href="mutable_buffer.html#asio.reference.mutable_buffer.member_functions">Member
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<a class="link" href="mutable_buffer/data.html" title="mutable_buffer::data"><span class="bold"><strong>data</strong></span></a>
</p>
</td>
<td>
<p>
Get a pointer to the beginning of the memory range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="mutable_buffer/mutable_buffer.html" title="mutable_buffer::mutable_buffer"><span class="bold"><strong>mutable_buffer</strong></span></a> <span class="silver">[constructor]</span>
</p>
</td>
<td>
<p>
Construct an empty buffer. <br> <span class="silver"> —</span><br> Construct a buffer to
represent a given memory range.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="mutable_buffer/operator_plus__eq_.html" title="mutable_buffer::operator+="><span class="bold"><strong>operator+=</strong></span></a>
</p>
</td>
<td>
<p>
Move the start of the buffer by the specified number of bytes.
</p>
</td>
</tr>
<tr>
<td>
<p>
<a class="link" href="mutable_buffer/size.html" title="mutable_buffer::size"><span class="bold"><strong>size</strong></span></a>
</p>
</td>
<td>
<p>
Get the size of the memory range.
</p>
</td>
</tr>
</tbody>
</table></div>
<h5>
<a name="asio.reference.mutable_buffer.h1"></a>
<span><a name="asio.reference.mutable_buffer.related_functions"></a></span><a class="link" href="mutable_buffer.html#asio.reference.mutable_buffer.related_functions">Related
Functions</a>
</h5>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Name
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody><tr>
<td>
<p>
<a class="link" href="mutable_buffer/operator_plus_.html" title="mutable_buffer::operator+"><span class="bold"><strong>operator+</strong></span></a>
</p>
</td>
<td>
<p>
Create a new modifiable buffer that is offset from the start of
another.
</p>
</td>
</tr></tbody>
</table></div>
<p>
The <a class="link" href="mutable_buffer.html" title="mutable_buffer"><code class="computeroutput">mutable_buffer</code></a>
class provides a safe representation of a buffer that can be modified. It
does not own the underlying data, and so is cheap to copy or assign.
</p>
<h5>
<a name="asio.reference.mutable_buffer.h2"></a>
<span><a name="asio.reference.mutable_buffer.accessing_buffer_contents"></a></span><a class="link" href="mutable_buffer.html#asio.reference.mutable_buffer.accessing_buffer_contents">Accessing
Buffer Contents</a>
</h5>
<p>
The contents of a buffer may be accessed using the <code class="computeroutput">data()</code> and
<code class="computeroutput">size()</code> member functions:
</p>
<pre class="programlisting">asio::mutable_buffer b1 = ...;
std::size_t s1 = b1.size();
unsigned char* p1 = static_cast<unsigned char*>(b1.data());
</pre>
<p>
The <code class="computeroutput">data()</code> member function permits violations of type safety,
so uses of it in application code should be carefully considered.
</p>
<h5>
<a name="asio.reference.mutable_buffer.h3"></a>
<span><a name="asio.reference.mutable_buffer.requirements"></a></span><a class="link" href="mutable_buffer.html#asio.reference.mutable_buffer.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffer.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="multiple_exceptions/what.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="mutable_buffer/data.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>