diff options
Diffstat (limited to 'doc/html/boost/interprocess/basic_vectorbuf.html')
| -rw-r--r-- | doc/html/boost/interprocess/basic_vectorbuf.html | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/html/boost/interprocess/basic_vectorbuf.html b/doc/html/boost/interprocess/basic_vectorbuf.html index d8b42b52e3..2be57fef8e 100644 --- a/doc/html/boost/interprocess/basic_vectorbuf.html +++ b/doc/html/boost/interprocess/basic_vectorbuf.html @@ -46,56 +46,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#idp45028448-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#idp63832864-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#idp45030464-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#idp63834880-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#idp45020656-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp45021216-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#idp45023280-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#idp45024864-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#idp45026960-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#idp63825072-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp63825632-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#idp63827696-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#idp63829280-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#idp63831376-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="idp287986016"></a><h2>Description</h2> +<a name="idp263824000"></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="idp287989600"></a><h3> +<a name="idp263827584"></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="idp45028448-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="idp63832864-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="idp45030464-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="idp63834880-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="idp288025264"></a><h3> -<a name="idp45020656-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3> +<a name="idp263863216"></a><h3> +<a name="idp63825072-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="idp45021216-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="idp63825632-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="idp45023280-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="idp63827696-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="idp45024864-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="idp63829280-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="idp45026960-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="idp63831376-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> |