]>
Commit | Line | Data |
---|---|---|
7c673cae FG |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
2 | <HTML> | |
3 | <HEAD> | |
4 | <TITLE>Class Template mode_of</TITLE> | |
5 | <LINK REL="stylesheet" HREF="../../../../boost.css"> | |
6 | <LINK REL="stylesheet" HREF="../theme/iostreams.css"> | |
7 | </HEAD> | |
8 | <BODY> | |
9 | ||
10 | <!-- Begin Banner --> | |
11 | ||
12 | <H1 CLASS="title">Class Template <CODE>mode_of</CODE></H1> | |
13 | <HR CLASS="banner"> | |
14 | ||
15 | <!-- End Banner --> | |
16 | ||
17 | <DL class="page-index"> | |
18 | <DT><A href="#description">Description</A></DT> | |
19 | <DT><A href="#headers">Headers</A></DT> | |
20 | <DT><A href="#reference">Reference</A></DT> | |
21 | </DL> | |
22 | ||
23 | <HR> | |
24 | ||
25 | <A NAME="description"></A> | |
26 | <H2>Description</H2> | |
27 | ||
28 | <P><A HREF="http://www.boost.org/libs/mpl/doc/refmanual/metafunction.html" TARGET="_top">Metafunction</A> returning a <A HREF="../guide/modes.html#mode_tags">mode tag</A> corresponding the the <A HREF="../guide/modes.html">mode</A> of a model of one of the <A HREF="../guide/concepts.html#filter_concepts">Filter</A> or <A HREF="../guide/concepts.html#device_concepts">Device</A> concepts.</P> | |
29 | ||
30 | <A NAME="headers"></A> | |
31 | <H2>Headers</H2> | |
32 | ||
33 | <DL class="page-index"> | |
34 | <DT><A CLASS="header" HREF="../../../../boost/iostreams/traits.hpp"><CODE><boost/iostreams/traits.hpp></CODE></A></DT> | |
35 | </DL> | |
36 | ||
37 | <A NAME="reference"></A> | |
38 | <H2>Reference</H2> | |
39 | ||
40 | <H4>Synopsis</H4> | |
41 | ||
42 | <PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams { | |
43 | ||
44 | <SPAN CLASS="keyword">template</SPAN><<SPAN CLASS="keyword">typename</SPAN> <A HREF="#template_params" CLASS="documented">T</A>> | |
45 | <SPAN CLASS="keyword">struct</SPAN> mode_of { | |
46 | <SPAN CLASS="keyword">typedef</SPAN> <SPAN CLASS="omitted">see below</SPAN> <A HREF="#type" CLASS="documented">type</A>; | |
47 | }; | |
48 | ||
49 | } } <SPAN CLASS="comment">// End namespace boost::io</SPAN></PRE> | |
50 | ||
51 | <A NAME="template_params"></A> | |
52 | <H4>Template parameters</H4> | |
53 | ||
54 | <TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2> | |
55 | <TR> | |
56 | <TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD> | |
57 | <TD>A Model of one of the <A HREF="../guide/concepts.html#filter_concepts">Filter</A> or <A HREF="../guide/concepts.html#device_concepts">Device</A> concepts</TD> | |
58 | </TR> | |
59 | </TABLE> | |
60 | ||
61 | <A NAME="type"></A> | |
62 | <H4><CODE>mode_of::type</CODE></H4> | |
63 | ||
64 | <PRE CLASS="broken_ie"> <SPAN CLASS="keyword">typedef</SPAN> <SPAN CLASS="omitted">implementation-defined</SPAN> <A HREF="#type" CLASS="documented">type</A>;</PRE> | |
65 | ||
66 | <P>The most-derived <A HREF="../guide/modes.html#mode_tags">mode tag</A> to which <A HREF="../guide/traits.html#category"><CODE>category_of<T>::type</CODE></A> is convertible. If there is no such most-derived tag, a compile-time error occurs.</P> | |
67 | ||
68 | <P>Modes assigned to standard library types are displayed in the following table.</P> | |
69 | ||
70 | <TABLE STYLE="margin-bottom:2em" BORDER=1 CELLPADDING=4> | |
71 | <TR><TH><CODE>T</CODE></TH><TH><CODE>category</CODE></TH></TR> | |
72 | <TR> | |
73 | <TD VALIGN="top">Specialization of <CODE>std::basic_iostream</CODE>, or derived from such a specialization</TD> | |
74 | <TD><CODE>seekable</CODE></TD> | |
75 | </TR> | |
76 | <TR> | |
77 | <TD VALIGN="top">Specialization of <CODE>std::basic_istream</CODE>, or derived from such a specialization</TD> | |
78 | <TD><CODE>input_seekable</CODE></TD> | |
79 | </TR> | |
80 | <TR> | |
81 | <TD VALIGN="top">Specialization of <CODE>std::basic_ostream</CODE>, or derived from such a specialization</TD> | |
82 | <TD><CODE>output_seekable</CODE></TD> | |
83 | </TR> | |
84 | <TR> | |
85 | <TD VALIGN="top">Specialization of <CODE>std::basic_streambuf</CODE>, or derived from such a specialization</TD> | |
86 | <TD><CODE>seekable</CODE></TD> | |
87 | </TR> | |
88 | <TR> | |
89 | <TD VALIGN="top">Specialization of <CODE>std::back_insert_iterator</CODE>, or derived from such a specialization</TD> | |
90 | <TD><CODE>output</CODE></TD> | |
91 | </TR> | |
92 | </TABLE> | |
93 | ||
94 | <!-- Begin Footer --> | |
95 | ||
96 | <HR> | |
97 | ||
98 | <P CLASS="copyright">© Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>© Copyright 2004-2007 <a href="http://www.coderage.com/turkanis/" target="_top">Jonathan Turkanis</a></P> | |
99 | <P CLASS="copyright"> | |
100 | 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>) | |
101 | </P> | |
102 | ||
103 | <!-- End Footer --> | |
104 | ||
105 | </BODY> |