Files
iostreams/doc/classes/mode.html
Jonathan Turkanis b85cc3c126 fixed broken link
[SVN r27130]
2005-02-05 01:59:51 +00:00

111 lines
4.5 KiB
HTML
Executable File

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<TITLE>Class Template io_mode</TITLE>
<LINK REL='stylesheet' HREF='../../../../boost.css'>
<LINK REL='stylesheet' HREF='../theme/iostreams.css'>
</HEAD>
<BODY>
<!-- Begin Banner -->
<H1 CLASS='title'>Class Template <CODE>io_mode</CODE></H1>
<HR CLASS='banner'>
<!-- End Banner -->
<DL class='page-index'>
<DT><A href='#description'>Description</A></DT>
<DT><A href='#headers'>Headers</A></DT>
<DT><A href='#reference'>Reference</A></DT>
</DL>
<HR>
<A NAME='description'>
<H2>Description</H2>
<P><A HREF="http://www.boost.org/libs/mpl/doc/refmanual/metafunction.html" TARGET='_top'>Metafunction</A> returning a <A HREF="../modes.html#mode_tags">mode tag</A> corresponding the the <A HREF="../modes.html">i/o mode</A> of a model of one of the <A HREF="../concepts.html#filter_concepts">Filter</A> or <A HREF="../concepts.html#device_concepts">Device</A> concepts or of a standard stream or stream buffer.</P>
<A NAME='headers'>
<H2>Headers</H2>
<DL class='page-index'>
<DT><A CLASS='header' HREF='../../../../boost/iostreams/traits.hpp'><CODE>&lt;boost/iostreams/traits.hpp&gt;</CODE></A></DT>
</DL>
<A NAME='reference'>
<H2>Reference</H2>
<H4>Synopsis</H4>
<PRE CLASS='broken_ie'><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
<SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> <A HREF='#template_params' CLASS='documented'>T</A>&gt;
<SPAN CLASS="keyword">struct</SPAN> io_mode {
<SPAN CLASS='keyword'>typedef</SPAN> <SPAN CLASS='omitted'>see below</SPAN> <A HREF='#type' CLASS='documented'>type</A>;
};
} } <SPAN CLASS='comment'>// End namespace boost::io</SPAN></PRE>
<A NAME='template_params'></A>
<H4>Template parameters</H4>
<TABLE STYLE='margin-left:2em' BORDER=0 CELLPADDING=2>
<TR>
<TD VALIGN='top'><I>T</I></TD><TD WIDTH='2em' VALIGN='top'>-</TD>
<TD>A Model of one of the <A HREF="../concepts.html#filter_concepts">Filter</A> or <A HREF="../concepts.html#device_concepts">Device</A> concepts</TD>
</TR>
</TABLE>
<A NAME='type'></A>
<H4><CODE>mode::type</CODE></H4>
<PRE CLASS='broken_ie'> <SPAN CLASS='keyword'>typedef</SPAN> <SPAN CLASS='omitted'>implementation-defined</SPAN> <A HREF='#type' CLASS='documented'>type</A>;</PRE>
<P>The most-derived <A HREF="../modes.html#mode_tags">mode tag</A> to which <A HREF="../traits.html#category"><CODE>io_category&lt;T&gt;::type</CODE></A> is convertible. If there is no such most-derived tag, a compile-time error occurs.</P>
<P>Modes assigned to standard library types are displayed in the following table. For standard streams and stream buffers, if the i/o mode shown below does not acurately reflect a particular implementation, the function template <A HREF='../functions/adapt.html'><CODE>adapt</CODE></A> may be used.</P>
<TABLE STYLE='margin-bottom:2em' BORDER=1 CELLPADDING=4>
<TR><TH><CODE>T</CODE></TH><TH><CODE>category</CODE></TH></TR>
<TR>
<TD VALIGN='top'><A NAME='print_CR'></A>Specialization of <CODE>std::basic_iostream</CODE>, or derived from such a specialization</TD>
<TD><CODE>seekable</CODE></TD>
</TR>
<TR>
<TD VALIGN='top'><A NAME='print_CR'></A>Specialization of <CODE>std::basic_istream</CODE>, or derived from such a specialization</TD>
<TD><CODE>input_seekable</CODE></TD>
</TR>
<TR>
<TD VALIGN='top'><A NAME='print_CR'></A>Specialization of <CODE>std::basic_ostream</CODE>, or derived from such a specialization</TD>
<TD><CODE>output_seekable</CODE></TD>
</TR>
<TR>
<TD VALIGN='top'><A NAME='print_CR'></A>Specialization of <CODE>std::basic_streambuf</CODE>, or derived from such a specialization</TD>
<TD><CODE>seekable</CODE></TD>
</TR>
<TR>
<TD VALIGN='top'><A NAME='print_CR'></A>Specialization of <CODE>std::back_insert_iterator</CODE>, or derived from such a specialization</TD>
<TD><CODE>output</CODE></TD>
</TR>
</TABLE>
<!-- Begin Footer -->
<HR>
<P CLASS='copyright'>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
20 May, 2004
<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
</P>
<P CLASS='copyright'>&copy; Copyright Jonathan Turkanis, 2004</P>
<P CLASS='copyright'>
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'>http://www.boost.org/LICENSE_1_0.txt</A>)
</P>
<!-- End Footer -->
</BODY>