mode.html 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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. <!-- Begin Banner -->
  10. <H1 CLASS="title">Class Template <CODE>mode_of</CODE></H1>
  11. <HR CLASS="banner">
  12. <!-- End Banner -->
  13. <DL class="page-index">
  14. <DT><A href="#description">Description</A></DT>
  15. <DT><A href="#headers">Headers</A></DT>
  16. <DT><A href="#reference">Reference</A></DT>
  17. </DL>
  18. <HR>
  19. <A NAME="description"></A>
  20. <H2>Description</H2>
  21. <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>
  22. <A NAME="headers"></A>
  23. <H2>Headers</H2>
  24. <DL class="page-index">
  25. <DT><A CLASS="header" HREF="../../../../boost/iostreams/traits.hpp"><CODE>&lt;boost/iostreams/traits.hpp&gt;</CODE></A></DT>
  26. </DL>
  27. <A NAME="reference"></A>
  28. <H2>Reference</H2>
  29. <H4>Synopsis</H4>
  30. <PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
  31. <SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> <A HREF="#template_params" CLASS="documented">T</A>&gt;
  32. <SPAN CLASS="keyword">struct</SPAN> mode_of {
  33. <SPAN CLASS="keyword">typedef</SPAN> <SPAN CLASS="omitted">see below</SPAN> <A HREF="#type" CLASS="documented">type</A>;
  34. };
  35. } } <SPAN CLASS="comment">// End namespace boost::io</SPAN></PRE>
  36. <A NAME="template_params"></A>
  37. <H4>Template parameters</H4>
  38. <TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
  39. <TR>
  40. <TD VALIGN="top"><I>T</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
  41. <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>
  42. </TR>
  43. </TABLE>
  44. <A NAME="type"></A>
  45. <H4><CODE>mode_of::type</CODE></H4>
  46. <PRE CLASS="broken_ie"> <SPAN CLASS="keyword">typedef</SPAN> <SPAN CLASS="omitted">implementation-defined</SPAN> <A HREF="#type" CLASS="documented">type</A>;</PRE>
  47. <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&lt;T&gt;::type</CODE></A> is convertible. If there is no such most-derived tag, a compile-time error occurs.</P>
  48. <P>Modes assigned to standard library types are displayed in the following table.</P>
  49. <TABLE STYLE="margin-bottom:2em" BORDER=1 CELLPADDING=4>
  50. <TR><TH><CODE>T</CODE></TH><TH><CODE>category</CODE></TH></TR>
  51. <TR>
  52. <TD VALIGN="top">Specialization of <CODE>std::basic_iostream</CODE>, or derived from such a specialization</TD>
  53. <TD><CODE>seekable</CODE></TD>
  54. </TR>
  55. <TR>
  56. <TD VALIGN="top">Specialization of <CODE>std::basic_istream</CODE>, or derived from such a specialization</TD>
  57. <TD><CODE>input_seekable</CODE></TD>
  58. </TR>
  59. <TR>
  60. <TD VALIGN="top">Specialization of <CODE>std::basic_ostream</CODE>, or derived from such a specialization</TD>
  61. <TD><CODE>output_seekable</CODE></TD>
  62. </TR>
  63. <TR>
  64. <TD VALIGN="top">Specialization of <CODE>std::basic_streambuf</CODE>, or derived from such a specialization</TD>
  65. <TD><CODE>seekable</CODE></TD>
  66. </TR>
  67. <TR>
  68. <TD VALIGN="top">Specialization of <CODE>std::back_insert_iterator</CODE>, or derived from such a specialization</TD>
  69. <TD><CODE>output</CODE></TD>
  70. </TR>
  71. </TABLE>
  72. <!-- Begin Footer -->
  73. <HR>
  74. <P CLASS="copyright">&copy; Copyright 2008 <a href="http://www.coderage.com/" target="_top">CodeRage, LLC</a><br/>&copy; Copyright 2004-2007 <a href="https://www.boost.org/users/people/jonathan_turkanis.html" target="_top">Jonathan Turkanis</a></P>
  75. <P CLASS="copyright">
  76. 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>)
  77. </P>
  78. <!-- End Footer -->
  79. </BODY>