doc/html/boost/interprocess/basic_ivectorstream.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template basic_ivectorstream</title>
   5 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   8 <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header &lt;boost/interprocess/streams/vectorstream.hpp&gt;">
   9 <link rel="prev" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">
  10 <link rel="next" href="basic_ovectorstream.html" title="Class template basic_ovectorstream">
  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="basic_vectorbuf.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_ovectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="refentry">
  26 <a name="boost.interprocess.basic_ivectorstream"></a><div class="titlepage"></div>
  27 <div class="refnamediv">
  28 <h2><span class="refentrytitle">Class template basic_ivectorstream</span></h2>
  29 <p>boost::interprocess::basic_ivectorstream</p>
  30 </div>
  31 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  32 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.streams.vectorstream_hpp" title="Header &lt;boost/interprocess/streams/vectorstream.hpp&gt;">boost/interprocess/streams/vectorstream.hpp</a>&gt;
  33
  34 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharVector<span class="special">,</span> <span class="keyword">typename</span> CharTraits<span class="special">&gt;</span>
  35 <span class="keyword">class</span> <a class="link" href="basic_ivectorstream.html" title="Class template basic_ivectorstream">basic_ivectorstream</a> <span class="special">:</span>
  36   <span class="keyword">public</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special">&lt;</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">&gt;</span>
  37 <span class="special">{</span>
  38 <span class="keyword">public</span><span class="special">:</span>
  39   <span class="comment">// types</span>
  40   <span class="keyword">typedef</span> <span class="identifier">CharVector</span>                                                               <a name="boost.interprocess.basic_ivectorstream.vector_type"></a><span class="identifier">vector_type</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special">&lt;</span> <span class="keyword">typename</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">&gt;</span><span class="special">::</span><span class="identifier">char_type</span> <a name="boost.interprocess.basic_ivectorstream.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special">&lt;</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">int_type</span>                        <a name="boost.interprocess.basic_ivectorstream.int_type"></a><span class="identifier">int_type</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special">&lt;</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">pos_type</span>                        <a name="boost.interprocess.basic_ivectorstream.pos_type"></a><span class="identifier">pos_type</span><span class="special">;</span>
  44   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special">&lt;</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">off_type</span>                        <a name="boost.interprocess.basic_ivectorstream.off_type"></a><span class="identifier">off_type</span><span class="special">;</span>
  45   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special">&lt;</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">traits_type</span>                     <a name="boost.interprocess.basic_ivectorstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span>
  46
  47   <span class="comment">// <a class="link" href="basic_ivectorstream.html#boost.interprocess.basic_ivectorstreamconstruct-copy-destruct">construct/copy/destruct</a></span>
  48   <a class="link" href="basic_ivectorstream.html#idp66476960-bb"><span class="identifier">basic_ivectorstream</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="special">;</span>
  49   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VectorParameter<span class="special">&gt;</span>
  50     <a class="link" href="basic_ivectorstream.html#idp66478688-bb"><span class="identifier">basic_ivectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&amp;</span><span class="special">,</span>
  51                         <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="special">;</span>
  52
  53   <span class="comment">// <a class="link" href="basic_ivectorstream.html#idp66467296-bb">public member functions</a></span>
  54   <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special">&lt;</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span> <span class="special">*</span> <a class="link" href="basic_ivectorstream.html#idp66467856-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  55   <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp66469728-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  56   <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&amp;</span> <a class="link" href="basic_ivectorstream.html#idp66471792-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  57   <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp66473376-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>
  58   <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp66475472-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  59 <span class="special">}</span><span class="special">;</span></pre></div>
  60 <div class="refsect1">
  61 <a name="idp247626032"></a><h2>Description</h2>
  62 <p>A basic_istream 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>
  63 <div class="refsect2">
  64 <a name="idp247626960"></a><h3>
  65 <a name="boost.interprocess.basic_ivectorstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ivectorstream</code>
  66         public
  67        construct/copy/destruct</h3>
  68 <div class="orderedlist"><ol class="orderedlist" type="1">
  69 <li class="listitem">
  70 <pre class="literallayout"><a name="idp66476960-bb"></a><span class="identifier">basic_ivectorstream</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="special">;</span></pre>
  71 <p>Constructor. Throws if vector_type default constructor throws. </p>
  72 </li>
  73 <li class="listitem">
  74 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> VectorParameter<span class="special">&gt;</span>
  75   <a name="idp66478688-bb"></a><span class="identifier">basic_ivectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&amp;</span> param<span class="special">,</span>
  76                       <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="special">;</span></pre>
  77 <p>Constructor. Throws if vector_type(const VectorParameter &amp;param) throws. </p>
  78 </li>
  79 </ol></div>
  80 </div>
  81 <div class="refsect2">
  82 <a name="idp247654816"></a><h3>
  83 <a name="idp66467296-bb"></a><code class="computeroutput">basic_ivectorstream</code> public member functions</h3>
  84 <div class="orderedlist"><ol class="orderedlist" type="1">
  85 <li class="listitem">
  86 <pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special">&lt;</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">&gt;</span> <span class="special">*</span> <a name="idp66467856-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>
  87 <p>Returns the address of the stored stream buffer. </p>
  88 </li>
  89 <li class="listitem">
  90 <pre class="literallayout"><span class="keyword">void</span> <a name="idp66469728-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&amp;</span> vect<span class="special">)</span><span class="special">;</span></pre>
  91 <p>Swaps the underlying vector with the passed vector. This function resets the read position in the stream. Does not throw. </p>
  92 </li>
  93 <li class="listitem">
  94 <pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&amp;</span> <a name="idp66471792-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>
  95 <p>Returns a const reference to the internal vector. Does not throw. </p>
  96 </li>
  97 <li class="listitem">
  98 <pre class="literallayout"><span class="keyword">void</span> <a name="idp66473376-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>
  99 <p>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </p>
 100 </li>
 101 <li class="listitem">
 102 <pre class="literallayout"><span class="keyword">void</span> <a name="idp66475472-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 103 <p>Calls clear() method of the internal vector. Resets the stream to the first position. </p>
 104 </li>
 105 </ol></div>
 106 </div>
 107 </div>
 108 </div>
 109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 110 <td align="left"></td>
 111 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2012 Ion Gaztanaga<p>
 112         Distributed under the Boost Software License, Version 1.0. (See accompanying
 113         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>)
 114       </p>
 115 </div></td>
 116 </tr></table>
 117 <hr>
 118 <div class="spirit-nav">
 119 <a accesskey="p" href="basic_vectorbuf.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_ovectorstream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 120 </div>
 121 </body>
 122 </html>