STD::BASIC_ISTREAM_SENTRY(3)

💖 std::basic_istream< _CharT, _Traits >::sentry — Library Functions Manual 💖

okay bestie, listen up: this is a page straight out of the libstdc++ manual, all about std::basic_istream< _CharT, _Traits >::sentry, and it's genuinely one of those little behind-the-scenes icons that does SO much work while nobody claps for it. main character energy, fr fr. let's get into it 🎀

---

✨ NAME ✨

std::basic_istream< _CharT, _Traits >::sentry — Performs setup work for input streams.

like... that's it, that's the whole vibe. it sets stuff up. no cap. 💅

---

🌸 SYNOPSIS 🌸

#include <istream>

🦋 Public Types

typedef __istream_type::__ctype_type __ctype_type
typedef _Traits::int_type __int_type
typedef basic_istream< _CharT, _Traits > __istream_type
typedef basic_streambuf< _CharT, _Traits > __streambuf_type
typedef _Traits traits_type

and the last one there? traits_type is your easy access to dependent types, bestie. a lil shortcut, we love her 🫶

🧚 Public Member Functions

sentry (basic_istream< _CharT, _Traits > &__is, bool __noskipws=false)

The constructor performs all the work.

operator bool () const

Quick status checking.

---

👑 Detailed Description

template<typename _CharT, typename _Traits>
class std::basic_istream< _CharT, _Traits >::sentry

"Performs setup work for input streams." ✨

okay so here's the tea ☕ — objects of this class get created before all of the standard extractors are run. she's the girl who shows up early and gets everything ready before the party starts. she is responsible for exception-safe prefix and suffix operations, although ngl, only prefix actions are currently required by the standard. the suffix ones are out here living their best unsupervised life 🙈

---

💜 Member Typedef Documentation

template<typename _CharT, typename _Traits> typedef _Traits
std::basic_istream< _CharT, _Traits >::sentry::traits_type

Easy access to dependent types. literally just that. she's a convenience girlie and she knows it 💅

---

🎀 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. yes, ALL of it. she's carrying the entire operation on her back and doesn't even complain 😭

Parameters

• __is — The input stream to guard.
• __noskipws — Whether to consume whitespace or not.

okay so here's the important part, don't skim this 🫶 If the stream state is good (__is.good() is true), then the following actions are performed, otherwise the sentry state is false (not okay) 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). slay ✨

References std::basic_istream< _CharT, _Traits >::basic_istream(), std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::good(), and std::ios_base::goodbit.

---

⭐ Member Function Documentation

template<typename _CharT, typename _Traits> std::basic_istream< _CharT,
    _Traits >::sentry::operator bool () 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). obsessed with the simplicity honestly 🌈

---

🌷 Author

Generated automatically by Doxygen for libstdc++ from the source code.

---

and that's the whole page bestie, no notes 💖 this came straight from the libstdc++ manual, same title, same std::basic...s >::sentry(3) energy — go forth and let your sentries guard your streams, periodt 🦋✨👑