std::basic_istream< _CharT, _Traits >::sentry - Performs setup work for input streams.
Contents
Constructor & Destructor Documentation
template<typename_CharT,typename_Traits>std::basic_istream<_CharT,_Traits>::sentry::sentry(basic_istream<_CharT,_Traits>&__is,bool__noskipws=false)[explicit]
The constructor performs all the work.
Parameters__is The input stream to guard.
__noskipws Whether to consume whitespace or not.
If the stream state is good (__is.good() is true), then the following actions are performed, otherwise
the sentry state is false (notokay) and failbit is set in the stream state.
The sentry's preparatory actions are:
1. if the stream is tied to an output stream, is.tie()->flush() is called to synchronize the output
sequence
2. if __noskipws is false, and ios_base::skipws is set in is.flags(), the sentry extracts and discards
whitespace characters from the stream. The currently imbued locale is used to determine whether each
character is whitespace.
If the stream state is still good, then the sentry state becomes true (okay).
References std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit,
and std::ios_base::skipws.
Detailed Description
template<typename_CharT,typename_Traits>
class std::basic_istream< _CharT, _Traits >::sentry"Performs setup work for input streams.
Objects of this class are created before all of the standard extractors are run. It is responsible for
exception-safeprefixandsuffixoperations, although only prefix actions are currently required by the
standard.
Member Function Documentation
template<typename_CharT,typename_Traits>std::basic_istream<_CharT,_Traits>::sentry::operatorbool()const[inline],[explicit]
Quick status checking.
Returns
The sentry state.
For ease of use, sentries may be converted to booleans. The return value is that of the sentry state
(true == okay).
Member Typedef Documentation
template<typename_CharT,typename_Traits>typedef_Traitsstd::basic_istream<_CharT,_Traits>::sentry::traits_type
Easy access to dependent types.
Name
std::basic_istream< _CharT, _Traits >::sentry - Performs setup work for input streams.
Synopsis
#include <istream>
PublicTypestypedef__istream_type::__ctype_type__ctype_typetypedef _Traits::int_type __int_typetypedefbasic_istream< _CharT, _Traits > __istream_typetypedefbasic_streambuf< _CharT, _Traits > __streambuf_typetypedef _Traits traits_type
Easy access to dependent types.
PublicMemberFunctionssentry (basic_istream< _CharT, _Traits > &__is, bool __noskipws=false)
The constructor performs all the work.
operatorbool () const
Quick status checking.
