Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/libs/iostreams/doc/classes/char_traits.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 16 years ago

updated boost from 1_33_1 to 1_34_1
File size: 4.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<HTML>
3<HEAD>
4    <TITLE>Class Template chain</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>char_traits</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>
29    The class template <CODE>boost::iostreams::char_traits</CODE> is a derived class of <CODE>std::char_traits</CODE> which has an additional static function <A HREF='#would_block'><CODE>would_block</CODE></A>, used to indicate that an attempt to read a character has failed because no input is currently available.
30</P>
31
32<P>
33    The constants <CODE>WOULD_BLOCK</CODE> and <CODE>WWOULD_BLOCK</CODE> are provided for convenience.
34</P>
35
36<A NAME="headers"></A>
37<H2>Headers</H2>
38
39<DL class="page-index">
40  <DT><A CLASS="header" HREF="../../../../boost/iostreams/char_traits.hpp"><CODE>&lt;boost/iostreams/char_traits.hpp&gt;</CODE></A></DT>
41</DL>
42
43<A NAME="reference"></A>
44<H2>Reference</H2>
45
46<A NAME="synopsis"></A>
47<H3>Synopsis</H3>
48
49<PRE CLASS="broken_ie"><SPAN CLASS="keyword">namespace</SPAN> boost { <SPAN CLASS="keyword">namespace</SPAN> iostreams {
50
51<SPAN CLASS="keyword">const</SPAN> <SPAN CLASS="keyword">int</SPAN> <A CLASS="documented" HREF="#WOULD_BLOCK">WOULD_BLOCK</A>;
52
53<SPAN CLASS="keyword">const</SPAN> std::wint_t <A CLASS="documented" HREF="#WWOULD_BLOCK">WWOULD_BLOCK</A>;
54
55<SPAN CLASS="keyword">template</SPAN>&lt;<SPAN CLASS="keyword">typename</SPAN> <A CLASS="documented" HREF="#template_params">Ch</A>&gt;
56<SPAN CLASS="keyword">class</SPAN> <A CLASS="documented" HREF="#template_params">char_traits</A> : public std::char_traits&lt;Ch&gt; {
57    <SPAN CLASS='keyword'>static</SPAN> <SPAN CLASS='keyword'>typename</SPAN> std::char_traits&lt;Ch&gt;::int_type <A CLASS='documented' HREF='#would_block'>would_block</A>();
58};
59
60} } // End namespace boost::io</PRE>
61
62<A NAME="WOULD_BLOCK"></A>
63<H3>Constant <CODE>WOULD_BLOCK</CODE></H3>
64
65<PRE CLASS="broken_ie">    <SPAN CLASS="keyword">const</SPAN> <SPAN CLASS="keyword">int</SPAN> WOULD_BLOCK;</PRE>
66
67<P>The return value of <CODE>char_traits&lt;char&gt;::would_block</CODE>. Used by the function template <A HREF="../functions/get.html"><CODE>get</CODE></A> to indicate that no character could be returned because input was temporarily unavailable.</P>
68
69<A NAME="WWOULD_BLOCK"></A>
70<H3>Constant <CODE>WWOULD_BLOCK</CODE></H3>
71
72<PRE CLASS="broken_ie">    <SPAN CLASS="keyword">const</SPAN> std::wint_t WWOULD_BLOCK;</PRE>
73
74<P>The return value of <CODE>char_traits&lt;wchar_t&gt;::would_block</CODE>. Used by the function template <A HREF="../functions/get.html"><CODE>get</CODE></A> to indicate that no character could be returned because input was temporarily unavailable.</P>
75
76<A NAME="char_traits"></A>
77<H3>Class Template <CODE>boost::iostreams::char_traits</CODE></H3>
78
79<A NAME="template_params"></A>
80<H4>Template parameters</H4>
81
82<TABLE STYLE="margin-left:2em" BORDER=0 CELLPADDING=2>
83    <TR>
84        <TD VALIGN="top"><I>Ch</I></TD><TD WIDTH="2em" VALIGN="top">-</TD>
85        <TD>The character type</TD>
86    </TR>
87</TABLE>
88
89<A NAME="char_traits"></A>
90<H4><CODE>char_traits::would_block</CODE></H4>
91
92<PRE CLASS="broken_ie">    <SPAN CLASS='keyword'>static</SPAN> <SPAN CLASS='keyword'>typename</SPAN> std::char_traits&lt;Ch&gt;::int_type would_block();</PRE>
93
94<P>
95    Returns an instance of <CODE>int_type</CODE> used by the function template <A HREF='../functions/get.html'><CODE>get</CODE></A> to indicate that an attempt to read a character from a <A HREF='../concepts/source.html'>Source</A> has failed because no input is currently available. Future attempts to read a character may succeed.
96</P>
97
98<!-- Begin Footer -->
99
100<HR>
101<P CLASS="copyright">Revised
102<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
10320 May, 2004
104<!--webbot bot="Timestamp" endspan i-checksum="38504" -->
105</P>
106
107<P CLASS="copyright">&copy; Copyright <A HREF="http://www.kangaroologic.com" TARGET="_top">Jonathan Turkanis</A>, 2004</P>
108<P CLASS="copyright"> 
109    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>)
110</P>
111
112<!-- End Footer -->
113
114</BODY>
Note: See TracBrowser for help on using the repository browser.