diff options
Diffstat (limited to 'doc/html/boost/interprocess/basic_vectorstream.html')
-rw-r--r-- | doc/html/boost/interprocess/basic_vectorstream.html | 44 |
1 files changed, 23 insertions, 21 deletions
diff --git a/doc/html/boost/interprocess/basic_vectorstream.html b/doc/html/boost/interprocess/basic_vectorstream.html index f1fc5b9128..1ef3571550 100644 --- a/doc/html/boost/interprocess/basic_vectorstream.html +++ b/doc/html/boost/interprocess/basic_vectorstream.html @@ -4,7 +4,7 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Class template basic_vectorstream</title> <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.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_ovectorstream.html" title="Class template basic_ovectorstream"> @@ -33,7 +33,9 @@ <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header <boost/interprocess/streams/vectorstream.hpp>">boost/interprocess/streams/vectorstream.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharVector<span class="special">,</span> <span class="keyword">typename</span> CharTraits<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="basic_vectorstream.html" title="Class template basic_vectorstream">basic_vectorstream</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_vectorstream.html" title="Class template basic_vectorstream">basic_vectorstream</a> <span class="special">:</span> + <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_iostream</span><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">::</span><span class="identifier">value_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> +<span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// types</span> <span class="keyword">typedef</span> <span class="identifier">CharVector</span> <a name="boost.interprocess.basic_vectorstream.vector_type"></a><span class="identifier">vector_type</span><span class="special">;</span> @@ -44,58 +46,58 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_vectorstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_vectorstream.html#boost.interprocess.basic_vectorstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_vectorstream.html#idp24197040-bb"><span class="identifier">basic_vectorstream</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> + <a class="link" href="basic_vectorstream.html#idm46037322067120-bb"><span class="identifier">basic_vectorstream</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> - <a class="link" href="basic_vectorstream.html#idp24198784-bb"><span class="identifier">basic_vectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_vectorstream.html#idm46037322065376-bb"><span class="identifier">basic_vectorstream</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_vectorstream.html#idp24187824-bb">public member functions</a></span> - <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_vectorstream.html#idp24188384-bb"><span class="identifier">rdbuf</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_vectorstream.html#idp24189808-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_vectorstream.html#idp24191872-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_vectorstream.html#idp24193456-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_vectorstream.html#idp24195552-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_vectorstream.html#idm46037322076336-bb">public member functions</a></span> + <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_vectorstream.html#idm46037322075776-bb"><span class="identifier">rdbuf</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_vectorstream.html#idm46037322074352-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_vectorstream.html#idm46037322072288-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_vectorstream.html#idm46037322070704-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_vectorstream.html#idm46037322068608-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="idp176233584"></a><h2>Description</h2> +<a name="idm45928009619760"></a><h2>Description</h2> <p>A basic_iostream class that 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="idp176234512"></a><h3> +<a name="idm45928009618832"></a><h3> <a name="boost.interprocess.basic_vectorstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_vectorstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp24197040-bb"></a><span class="identifier">basic_vectorstream</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"><a name="idm46037322067120-bb"></a><span class="identifier">basic_vectorstream</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> - <a name="idp24198784-bb"></a><span class="identifier">basic_vectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <a name="idm46037322065376-bb"></a><span class="identifier">basic_vectorstream</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="idp176268624"></a><h3> -<a name="idp24187824-bb"></a><code class="computeroutput">basic_vectorstream</code> public member functions</h3> +<a name="idm45928009584512"></a><h3> +<a name="idm46037322076336-bb"></a><code class="computeroutput">basic_vectorstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp24188384-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idm46037322075776-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp24189808-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="idm46037322074352-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="idp24191872-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="idm46037322072288-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="idp24193456-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="idm46037322070704-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>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp24195552-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="idm46037322068608-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> |