STD::BASIC_OSTREAM_SENTRY(3cxx)

🎀 NAME 🎀

okay so bestie, welcome to the manual page for std::basic_ostream< _CharT, _Traits >::sentry — manual name 3cxx, libstdc++ territory — and it performs setup work for output streams. 💅✨

🌈 SYNOPSIS 🌈

#include <ostream>

💖 Public Member Functions 💖

• sentry (basic_ostream< _CharT, _Traits > &__os) — the constructor performs preparatory work.
• ~sentry () — possibly flushes the stream.
• operator bool () const — quick status checking.

🦋 Detailed Description 🦋

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

So this class performs setup work for output streams. Objects of this class are created before all of the standard inserters are run. It is responsible for exception-safe prefix and suffix operations. No cap, that’s the whole vibe. 🫶

💖 Constructor & Destructor Documentation 💖

✨ sentry constructor ✨

template<typename _CharT , typename _Traits >
std::basic_ostream< _CharT, _Traits >::sentry::sentry (basic_ostream< _CharT, _Traits > & __os) [explicit]

The constructor performs preparatory work. 💅

• __os — The output stream to guard.

If the stream state is good (__os.good() is true), then if the stream is tied to another output stream, is.tie()->flush() is called to synchronize the output sequences.

If the stream state is still good, then the sentry state becomes true (okay). ✨

References: std::basic_ios< _CharT, _Traits >::bad(), std::ios_base::failbit, std::basic_ios< _CharT, _Traits >::good(), std::basic_ios< _CharT, _Traits >::setstate(), and std::basic_ios< _CharT, _Traits >::tie().

🎀 ~sentry destructor 🎀

template<typename _CharT , typename _Traits >
std::basic_ostream< _CharT, _Traits >::sentry::~sentry () [inline]

Possibly flushes the stream. If ios_base::unitbuf is set in os.flags(), and std::uncaught_exception() is true, the sentry destructor calls flush() on the output stream. 😭💧

References: std::ios_base::badbit, std::ios_base::flags(), std::basic_ios< _CharT, _Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::setstate(), std::uncaught_exception(), and std::ios_base::unitbuf.

✨ Member Function Documentation ✨

👑 operator bool 👑

template<typename _CharT , typename _Traits >
std::basic_ostream< _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). 🌟

🎀 Author 🎀

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

---

okay bye bestie 💜 — this page is from libstdc++ and the 3cxx manual, auto-generated by Doxygen from the source code. The footer doesn’t print a date, so that’s the source/version-and-date tea we’ve got. 🫶✨