diff options
Diffstat (limited to 'doc/html/boost/interprocess/basic_vectorbuf.html')
| -rw-r--r-- | doc/html/boost/interprocess/basic_vectorbuf.html | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/doc/html/boost/interprocess/basic_vectorbuf.html b/doc/html/boost/interprocess/basic_vectorbuf.html index 619fad8936..278f8ff252 100644 --- a/doc/html/boost/interprocess/basic_vectorbuf.html +++ b/doc/html/boost/interprocess/basic_vectorbuf.html @@ -6,8 +6,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header <boost/interprocess/streams/vectorstream.hpp>"> -<link rel="prev" href="basic_bufferstream.html" title="Class template basic_bufferstream"> -<link rel="next" href="basic_ivectorstream.html" title="Class template basic_ivectorstream"> +<link rel="prev" href="basic_ovectorstream.html" title="Class template basic_ovectorstream"> +<link rel="next" href="basic_vectorstream.html" title="Class template basic_vectorstream"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_bufferstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><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="basic_ivectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_ovectorstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><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="basic_vectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.basic_vectorbuf"></a><div class="titlepage"></div> @@ -45,56 +45,56 @@ <span class="keyword">typedef</span> <span class="identifier">CharTraits</span> <a name="boost.interprocess.basic_vectorbuf.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_vectorbuf.html#boost.interprocess.basic_vectorbufconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp66453376-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp56448448-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp66455392-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp56450464-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_vectorbuf.html#idp66445584-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp66446144-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorbuf.html#idp66448208-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp66449792-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp66451888-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_vectorbuf.html#idp56440656-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp56441216-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorbuf.html#idp56443280-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp56444864-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp56446960-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp247437424"></a><h2>Description</h2> +<a name="idp241095824"></a><h2>Description</h2> <p>A streambuf class that controls the transmission of elements to and from a <a class="link" href="basic_ivectorstream.html" title="Class template basic_ivectorstream">basic_ivectorstream</a>, <a class="link" href="basic_ovectorstream.html" title="Class template basic_ovectorstream">basic_ovectorstream</a> or <a class="link" href="basic_vectorstream.html" title="Class template basic_vectorstream">basic_vectorstream</a>. It holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p> <div class="refsect2"> -<a name="idp247441008"></a><h3> +<a name="idp241099408"></a><h3> <a name="boost.interprocess.basic_vectorbufconstruct-copy-destruct"></a><code class="computeroutput">basic_vectorbuf</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp66453376-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56448448-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type default constructor throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <span class="keyword">explicit</span> <a name="idp66455392-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <span class="keyword">explicit</span> <a name="idp56450464-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp247476624"></a><h3> -<a name="idp66445584-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3> +<a name="idp241134880"></a><h3> +<a name="idp56440656-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp66446144-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56441216-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp66448208-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp56443280-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a const reference to the internal vector. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp66449792-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56444864-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Preallocates memory from the internal vector. Resets the stream to the first position. Throws if the internals vector's memory allocation throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp66451888-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56446960-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Calls clear() method of the internal vector. Resets the stream to the first position. </p> </li> </ol></div> @@ -111,7 +111,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_bufferstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><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="basic_ivectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_ovectorstream.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp"><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="basic_vectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |