• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>buffer_copy (1 of 2 overloads)</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="../../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../buffer_copy.html" title="buffer_copy">
9<link rel="prev" href="../buffer_copy.html" title="buffer_copy">
10<link rel="next" href="overload2.html" title="buffer_copy (2 of 2 overloads)">
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="../buffer_copy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.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="boost_asio.reference.buffer_copy.overload1"></a><a class="link" href="overload1.html" title="buffer_copy (1 of 2 overloads)">buffer_copy
28        (1 of 2 overloads)</a>
29</h4></div></div></div>
30<p>
31          Copies bytes from a source buffer sequence to a target buffer sequence.
32        </p>
33<pre class="programlisting">template&lt;
34    typename <a class="link" href="../MutableBufferSequence.html" title="Mutable buffer sequence requirements">MutableBufferSequence</a>,
35    typename <a class="link" href="../ConstBufferSequence.html" title="Constant buffer sequence requirements">ConstBufferSequence</a>&gt;
36std::size_t buffer_copy(
37    const MutableBufferSequence &amp; target,
38    const ConstBufferSequence &amp; source);
39</pre>
40<h6>
41<a name="boost_asio.reference.buffer_copy.overload1.h0"></a>
42          <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.buffer_copy.overload1.parameters">Parameters</a>
43        </h6>
44<div class="variablelist">
45<p class="title"><b></b></p>
46<dl class="variablelist">
47<dt><span class="term">target</span></dt>
48<dd><p>
49                A modifiable buffer sequence representing the memory regions to which
50                the bytes will be copied.
51              </p></dd>
52<dt><span class="term">source</span></dt>
53<dd><p>
54                A non-modifiable buffer sequence representing the memory regions
55                from which the bytes will be copied.
56              </p></dd>
57</dl>
58</div>
59<h6>
60<a name="boost_asio.reference.buffer_copy.overload1.h1"></a>
61          <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.buffer_copy.overload1.return_value">Return
62          Value</a>
63        </h6>
64<p>
65          The number of bytes copied.
66        </p>
67<h6>
68<a name="boost_asio.reference.buffer_copy.overload1.h2"></a>
69          <span class="phrase"><a name="boost_asio.reference.buffer_copy.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.buffer_copy.overload1.remarks">Remarks</a>
70        </h6>
71<p>
72          The number of bytes copied is the lesser of:
73        </p>
74<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
75<li class="listitem">
76              <code class="computeroutput">buffer_size(target)</code>
77            </li>
78<li class="listitem">
79              <code class="computeroutput">buffer_size(source)</code>
80            </li>
81</ul></div>
82<p>
83          This function is implemented in terms of <code class="computeroutput">memcpy</code>, and consequently
84          it cannot be used to copy between overlapping memory regions.
85        </p>
86</div>
87<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
88<td align="left"></td>
89<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
90      Kohlhoff<p>
91        Distributed under the Boost Software License, Version 1.0. (See accompanying
92        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>)
93      </p>
94</div></td>
95</tr></table>
96<hr>
97<div class="spirit-nav">
98<a accesskey="p" href="../buffer_copy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../buffer_copy.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
99</div>
100</body>
101</html>
102