blob: db3bdbe19b202ffd438f1e2be029c7ee2c71503a [file] [log] [blame]
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>in</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../../index.html" title="Chapter&#160;1.&#160;Fusion 2.0">
<link rel="up" href="../i_o.html" title="I/O">
<link rel="prev" href="../i_o.html" title="I/O">
<link rel="next" href="out.html" title="out">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../i_o.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../i_o.html"><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="out.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="fusion.sequence.operator.i_o.in"></a><a class="link" href="in.html" title="in">in</a>
</h5></div></div></div>
<a name="fusion.sequence.operator.i_o.in.description"></a><h6>
<a name="id901464"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.description">Description</a>
</h6>
<p>
Read a <a class="link" href="../../../sequence.html" title="Sequence">Sequence</a> from an input
stream.
</p>
<a name="fusion.sequence.operator.i_o.in.synopsis"></a><h6>
<a name="id901486"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">typename</span> <span class="identifier">IStream</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">Sequence</span><span class="special">&gt;</span>
<span class="identifier">IStream</span><span class="special">&amp;</span>
<span class="keyword">operator</span><span class="special">&gt;&gt;(</span><span class="identifier">IStream</span><span class="special">&amp;</span> <span class="identifier">is</span><span class="special">,</span> <span class="identifier">Sequence</span><span class="special">&amp;</span> <span class="identifier">seq</span><span class="special">);</span>
</pre>
<a name="fusion.sequence.operator.i_o.in.parameters"></a><h6>
<a name="id901587"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
Parameter
</p>
</th>
<th>
<p>
Requirement
</p>
</th>
<th>
<p>
Description
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
is
</p>
</td>
<td>
<p>
An input stream.
</p>
</td>
<td>
<p>
Stream to extract information from.
</p>
</td>
</tr>
<tr>
<td>
<p>
seq
</p>
</td>
<td>
<p>
A <a class="link" href="../../../sequence.html" title="Sequence">Sequence</a>.
</p>
</td>
<td>
<p>
The sequence to read.
</p>
</td>
</tr>
</tbody>
</table></div>
<a name="fusion.sequence.operator.i_o.in.expression_semantics"></a><h6>
<a name="id901698"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.expression_semantics">Expression
Semantics</a>
</h6>
<pre class="programlisting"><span class="identifier">is</span> <span class="special">&gt;&gt;</span> <span class="identifier">seq</span>
</pre>
<p>
<span class="bold"><strong>Return type</strong></span>: IStream&amp;
</p>
<p>
<span class="bold"><strong>Semantics</strong></span>: For each element, <code class="computeroutput"><span class="identifier">e</span></code>, in sequence, <code class="computeroutput"><span class="identifier">seq</span></code>,
call <code class="computeroutput"><span class="identifier">is</span> <span class="special">&gt;&gt;</span>
<span class="identifier">e</span></code>.
</p>
<a name="fusion.sequence.operator.i_o.in.header"></a><h6>
<a name="id901778"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.header">Header</a>
</h6>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">sequence</span><span class="special">/</span><span class="identifier">io</span><span class="special">/</span><span class="identifier">in</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
<span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">fusion</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">in</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
</pre>
<a name="fusion.sequence.operator.i_o.in.example"></a><h6>
<a name="id901893"></a>
<a class="link" href="in.html#fusion.sequence.operator.i_o.in.example">Example</a>
</h6>
<pre class="programlisting"><a class="link" href="../../../container/vector.html" title="vector"><code class="computeroutput"><span class="identifier">vector</span></code></a><span class="special">&lt;</span><span class="keyword">int</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">char</span><span class="special">&gt;</span> <span class="identifier">v</span><span class="special">;</span>
<span class="identifier">std</span><span class="special">::</span><span class="identifier">cin</span> <span class="special">&gt;&gt;</span> <span class="identifier">v</span><span class="special">;</span>
</pre>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2001-2007 Joel de Guzman, Dan Marsden, Tobias
Schwinger<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../i_o.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../i_o.html"><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="out.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>