STD::BASIC_IOSTREAM(3)

📦

version 16.2.1+r23+gd564253eb6c8 · 15 versions

16.2.1+r23+gd564253eb6c8 · arch rolling, fedora 44 (latest)
11.5.0 · centos-stream 9
15.2.1 · centos-stream 9
16.2.1 · centos-stream 9
14.2.1 · centos-stream 9
12.2.1 · centos-stream 9
13.3.1 · centos-stream 9
14.4.1 · centos-stream 10
15.2.1 · centos-stream 10
16.2.1 · centos-stream 10
2024.07.05 · nixpkgs unstable, opensuse-leap 16.0
4.4.0 · nixpkgs unstable
15.3.1 · fedora 43
15.2.1 · fedora 43
16.0.1 · fedora 44

✨ NAME ✨

std::basic_iostream< _CharT, _Traits > — Template class basic_iostream.

This is the section 3 page from the Library Functions Manual. Okay bestie, this is the whole vibe of the class, and we're keeping every single detail, periodt. 💅

🌈 SYNOPSIS 🌈

#include <istream>

Inherits std::basic_istream< _CharT, _Traits >, and std::basic_ostream< _CharT, _Traits >.

Inherited by std::basic_fstream< char >, std::basic_fstream< wchar_t >, std::basic_stringstream< char >, std::basic_stringstream< wchar_t >, std::basic_fstream< _CharT, _Traits >, and std::basic_stringstream< _CharT, _Traits, _Alloc >.

💎 Public Types 💎

typedef ctype< _CharT > __ctype_type
typedef ctype< _CharT > __ctype_type — listed twice, exactly as the page says 💅
typedef basic_ios< _CharT, _Traits > __ios_type
typedef basic_ios< _CharT, _Traits > __ios_type — again, duplicate, no cap
typedef basic_istream< _CharT, _Traits > __istream_type
typedef num_get< _CharT, istreambuf_iterator< _CharT, _Traits > > __num_get_type
typedef num_put< _CharT, ostreambuf_iterator< _CharT, _Traits > > __num_put_type
typedef basic_ostream< _CharT, _Traits > __ostream_type
typedef basic_streambuf< _CharT, _Traits > __streambuf_type
typedef basic_streambuf< _CharT, _Traits > __streambuf_type — yes, twice again, iconic behavior
typedef _CharT char_type
enum event { erase_event, imbue_event, copyfmt_event } — The set of events that may be passed to an event callback.
typedef void(* event_callback) (event __e, ios_base &__b, int __i) — The type of an event callback function.
typedef _Ios_Fmtflags fmtflags — This is a bitmask type.
typedef _Traits::int_type int_type
typedef _Ios_Iostate iostate — This is a bitmask type.
typedef _Traits::off_type off_type
typedef _Ios_Openmode openmode — This is a bitmask type.
typedef _Traits::pos_type pos_type
typedef _Ios_Seekdir seekdir — This is an enumerated type.
typedef _Traits traits_type

👑 Public Member Functions 👑

basic_iostream (basic_streambuf< _CharT, _Traits > *__sb) — Constructor does nothing.
virtual ~basic_iostream () — Destructor does nothing.
template<typename _ValueT> basic_istream< _CharT, _Traits > & _M_extract (_ValueT &__v) — no description given, just the signature ✨
const locale & _M_getloc () const — Locale access.
template<typename _ValueT> basic_ostream< _CharT, _Traits > & _M_insert (_ValueT __v) — no description given, just the signature ✨
void _M_setstate (iostate __state) — no description given, just the signature ✨
bool bad () const — Fast error checking.
void clear (iostate __state=goodbit) — [Re]sets the error state.
basic_ios & copyfmt (const basic_ios &__rhs) — Copies fields of __rhs into this.
bool eof () const — Fast error checking.
iostate exceptions () const — Throwing exceptions on errors.
void exceptions (iostate __except) — Throwing exceptions on errors.
bool fail () const — Fast error checking.
char_type fill () const — Retrieves the empty character.
char_type fill (char_type __ch) — Sets a new empty character.
fmtflags flags () const — Access to format flags.
fmtflags flags (fmtflags __fmtfl) — Setting new format flags all at once.
__ostream_type & flush () — Synchronizing the stream buffer.
streamsize gcount () const — Character counting.
basic_istream< wchar_t > & getline (char_type *__s, streamsize __n, char_type __delim)
basic_istream< char > & getline (char_type *__s, streamsize __n, char_type __delim)

Both of those getline lines are Explicit specialization declarations, defined in src/istream.cc.

locale getloc () const — Locale access.
bool good () const — Fast error checking.
basic_istream< wchar_t > & ignore (streamsize __n)
basic_istream< char > & ignore (streamsize __n)
basic_istream< wchar_t > & ignore (streamsize __n, int_type __delim)
basic_istream< char > & ignore (streamsize __n, int_type __delim)
locale imbue (const locale &__loc) — Moves to a new locale.
long & iword (int __ix) — Access to integer array.
char narrow (char_type __c, char __dfault) const — Squeezes characters.
__ostream_type & operator<< (__streambuf_type *__sb) — Extracting from another streambuf.
__ostream_type & operator<< (const void *__p) — Pointer arithmetic inserters.
__ostream_type & operator<< (const volatile void *__p) — no description given, just the signature ✨
__ostream_type & operator<< (nullptr_t) — no description given, just the signature ✨
__istream_type & operator>> (__streambuf_type *__sb) — Extracting into another streambuf.
__istream_type & operator>> (void *&__p) — Basic arithmetic extractors.
streamsize precision () const — Flags access.
streamsize precision (streamsize __prec) — Changing flags.
void *& pword (int __ix) — Access to void pointer array.
basic_streambuf< _CharT, _Traits > * rdbuf () const — Accessing the underlying buffer.
basic_streambuf< _CharT, _Traits > * rdbuf (basic_streambuf< _CharT, _Traits > *__sb) — Changing the underlying buffer.
iostate rdstate () const — Returns the error state of the stream buffer.
void register_callback (event_callback __fn, int __index) — Add the callback __fn with parameter __index.
__ostream_type & seekp (off_type, ios_base::seekdir) — Changing the current write position.
__ostream_type & seekp (pos_type) — Changing the current write position.
fmtflags setf (fmtflags __fmtfl) — Setting new format flags.
fmtflags setf (fmtflags __fmtfl, fmtflags __mask) — Setting new format flags.
void setstate (iostate __state) — Sets additional flags in the error state.
pos_type tellp () — Getting the current write position.
basic_ostream< _CharT, _Traits > * tie () const — Fetches the current tied stream.
basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits > *__tiestr) — Ties this stream to an output stream.
void unsetf (fmtflags __mask) — Clearing format flags.
char_type widen (char __c) const — Widens characters.
streamsize width () const — Flags access.
streamsize width (streamsize __wide) — Changing flags.
__istream_type & operator>> (__istream_type &(*__pf)(__istream_type &)) — Interface for manipulators.
__istream_type & operator>> (__ios_type &(*__pf)(__ios_type &)) — Interface for manipulators.
__istream_type & operator>> (ios_base &(*__pf)(ios_base &)) — Interface for manipulators.

🦋 Extractors 🦋

All the operator>> functions (aka formatted input functions) have some common behavior. Each starts by constructing a temporary object of type std::basic_istream::sentry with the second argument (noskipws) set to false. This has several effects, concluding with the setting of a status flag; see the sentry documentation for more.

If the sentry status is good, the function tries to extract whatever data is appropriate for the type of the argument.

If an exception is thrown during extraction, ios_base::badbit will be turned on in the stream's error state (without causing an ios_base::failure to be thrown) and the original exception will be rethrown if badbit is set in the exceptions mask.

__istream_type & operator>> (bool &__n) — Integer arithmetic extractors.
__istream_type & operator>> (short &__n) — Integer arithmetic extractors.
__istream_type & operator>> (unsigned short &__n) — Integer arithmetic extractors.
__istream_type & operator>> (int &__n) — Integer arithmetic extractors.
__istream_type & operator>> (unsigned int &__n) — Integer arithmetic extractors.
__istream_type & operator>> (long &__n) — Integer arithmetic extractors.
__istream_type & operator>> (unsigned long &__n) — Integer arithmetic extractors.
__istream_type & operator>> (long long &__n) — Integer arithmetic extractors.
__istream_type & operator>> (unsigned long long &__n) — Integer arithmetic extractors.
__istream_type & operator>> (float &__f) — Floating point arithmetic extractors.
__istream_type & operator>> (double &__f) — Floating point arithmetic extractors.
__istream_type & operator>> (long double &__f) — Floating point arithmetic extractors.

🌸 Unformatted Input Functions 🌸

All the unformatted input functions have some common behavior. Each starts by constructing a temporary object of type std::basic_istream::sentry with the second argument (noskipws) set to true. This has several effects, concluding with the setting of a status flag; see the sentry documentation for more.

If the sentry status is good, the function tries to extract whatever data is appropriate for the type of the argument.

The number of characters extracted is stored for later retrieval by gcount().

int_type get () — Simple extraction.
__istream_type & get (char_type &__c) — Simple extraction.
__istream_type & get (char_type *__s, streamsize __n, char_type __delim) — Simple multiple-character extraction.
__istream_type & get (char_type *__s, streamsize __n) — Simple multiple-character extraction.
__istream_type & get (__streambuf_type &__sb, char_type __delim) — Extraction into another streambuf.
__istream_type & get (__streambuf_type &__sb) — Extraction into another streambuf.
__istream_type & getline (char_type *__s, streamsize __n, char_type __delim) — String extraction.
__istream_type & getline (char_type *__s, streamsize __n) — String extraction.
__istream_type & ignore (streamsize __n, int_type __delim) — Discarding characters.
__istream_type & ignore (streamsize __n) — Simple extraction.
__istream_type & ignore () — Simple extraction.
__istream_type & ignore (streamsize __n, char __delim) — Simple extraction.
int_type peek () — Looking ahead in the stream.
__istream_type & read (char_type *__s, streamsize __n) — Extraction without delimiters.
streamsize readsome (char_type *__s, streamsize __n) — Extraction until the buffer is exhausted, but no more.
__istream_type & putback (char_type __c) — Unextracting a single character.
__istream_type & unget () — Unextracting the previous character.
int sync () — Synchronizing the stream buffer.
pos_type tellg () — Getting the current read position.
__istream_type & seekg (pos_type) — Changing the current read position.
__istream_type & seekg (off_type, ios_base::seekdir) — Changing the current read position.

okay so these next overloads? They're the manipulator ones, and they're giving "hand me a function pointer and I'll call it on the stream" energy ✨

__ostream_type & operator<< (__ostream_type &(*__pf)(__ostream_type &)) — Interface for manipulators.
__ostream_type & operator<< (__ios_type &(*__pf)(__ios_type &)) — Interface for manipulators.
__ostream_type & operator<< (ios_base &(*__pf)(ios_base &)) — Interface for manipulators.

✨ Inserters ✨

All the operator<< functions (aka formatted output functions) have some common behavior, bestie. Each one starts by constructing a temporary object of type std::basic_ostream::sentry. That can have several effects, and it finishes by setting a status flag; see the sentry documentation for more 👀

If the sentry status is good, the function tries to generate whatever data is appropriate for the type of the argument.

If an exception is thrown during insertion, ios_base::badbit will be turned on in the stream's error state without causing an ios_base::failure to be thrown. The original exception will then be rethrown. 😭

__ostream_type & operator<< (long __n) — Integer arithmetic inserters.
__ostream_type & operator<< (unsigned long __n) — Integer arithmetic inserters.
__ostream_type & operator<< (bool __n) — Integer arithmetic inserters.
__ostream_type & operator<< (short __n) — Integer arithmetic inserters.
__ostream_type & operator<< (unsigned short __n) — Integer arithmetic inserters.
__ostream_type & operator<< (int __n) — Integer arithmetic inserters.
__ostream_type & operator<< (unsigned int __n) — Integer arithmetic inserters.
__ostream_type & operator<< (long long __n) — Integer arithmetic inserters.
__ostream_type & operator<< (unsigned long long __n) — Integer arithmetic inserters.
__ostream_type & operator<< (double __f) — Floating point arithmetic inserters.
__ostream_type & operator<< (float __f) — Floating point arithmetic inserters.
__ostream_type & operator<< (long double __f) — Floating point arithmetic inserters.

✨ Unformatted Output Functions ✨

All the unformatted output functions have some common behavior. Each starts by constructing a temporary object of type std::basic_ostream::sentry. This has several effects, concluding with the setting of a status flag; see the sentry documentation for more.

If the sentry status is good, the function tries to generate whatever data is appropriate for the type of the argument.

If an exception is thrown during insertion, ios_base::badbit will be turned on in the stream's error state. If badbit is on in the stream's exceptions mask, the exception will be rethrown without completing its actions. periodt, that's the rule.

__ostream_type & put (char_type __c) — Simple insertion.
__ostream_type & write (const char_type *__s, streamsize __n) — Character string insertion.
operator bool () const — The quick-and-easy status check.
bool operator! () const — The quick-and-easy status check.

✨ Static Public Member Functions ✨

static bool sync_with_stdio (bool __sync=true) — Interaction with the standard C I/O objects.
static int xalloc () throw () — Access to unique indices.

✨ Static Public Attributes ✨

static const openmode __noreplace — no description in the original, it's just sitting there, bestie 💀
static const fmtflags adjustfield — A mask of left|right|internal. Useful for the 2-arg form of setf.
static const openmode app — Seek to end before each write.
static const openmode ate — Open and seek to end immediately after opening.
static const iostate badbit — Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file).
static const fmtflags basefield — A mask of dec|oct|hex. Useful for the 2-arg form of setf.
static const seekdir beg — Request a seek relative to the beginning of the stream.
static const openmode binary — Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary.
static const fmtflags boolalpha — Insert/extract bool in alphabetic rather than numeric format.
static const seekdir cur — Request a seek relative to the current position within the sequence.
static const fmtflags dec — Converts integer input or generates integer output in decimal base.
static const seekdir end — Request a seek relative to the current end of the sequence.
static const iostate eofbit — Indicates that an input operation reached the end of an input sequence.
static const iostate failbit — Indicates that an input operation failed to read the expected characters, or that an output operation failed to generate the desired characters.
static const fmtflags fixed — Generate floating-point output in fixed-point notation.
static const fmtflags floatfield — A mask of scientific|fixed. Useful for the 2-arg form of setf.
static const iostate goodbit — Indicates all is well.
static const fmtflags hex — Converts integer input or generates integer output in hexadecimal base.
static const openmode in — Open for input. Default for ifstream and fstream.
static const fmtflags internal — Adds fill characters at a designated internal point in certain generated output, or identical to right if no such point is designated.
static const fmtflags left — Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.).
static const fmtflags oct — Converts integer input or generates integer output in octal base.
static const openmode out — Open for output. Default for ofstream and fstream.
static const fmtflags right — Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.).
static const fmtflags scientific — Generates floating-point output in scientific notation.
static const fmtflags showbase — Generates a prefix indicating the numeric base of generated integer output.
static const fmtflags showpoint — Generates a decimal-point character unconditionally in generated floating-point output.
static const fmtflags showpos — Generates a + sign in non-negative generated numeric output.
static const fmtflags skipws — Skips leading white space before certain input operations.
static const openmode trunc — Truncate an existing stream when opening. Default for ofstream.
static const fmtflags unitbuf — Flushes output after each output operation.
static const fmtflags uppercase — Replaces certain lowercase letters with their uppercase equivalents in generated output.

✨ Protected Types ✨

enum { _S_local_word_size }

✨ Protected Member Functions ✨

basic_iostream (basic_iostream &&__rhs)
basic_iostream (const basic_iostream &)=delete
void _M_cache_locale (const locale &__loc)
void _M_call_callbacks (event __ev) throw ()
void _M_dispose_callbacks (void) throw ()
template<typename _ValueT> __istream_type & _M_extract (_ValueT &__v)
_Words & _M_grow_words (int __index, bool __iword)
void _M_init () throw ()
template<typename _ValueT> __ostream_type & _M_insert (_ValueT __v)
void _M_move (ios_base &) noexcept
void _M_swap (ios_base &__rhs) noexcept
void init (basic_streambuf< _CharT, _Traits > *__sb) — All setup is performed here.
void move (basic_ios &&__rhs)
void move (basic_ios &__rhs)
basic_iostream & operator= (basic_iostream &&__rhs)
basic_iostream & operator= (const basic_iostream &)=delete
void set_rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
void swap (basic_ios &__rhs) noexcept
void swap (basic_iostream &__rhs)
void swap (basic_istream &__rhs)
void swap (basic_ostream &__rhs)

✨ Protected Attributes ✨

_Callback_list * _M_callbacks
const __ctype_type * _M_ctype
iostate _M_exception
char_type _M_fill
bool _M_fill_init
fmtflags _M_flags
streamsize _M_gcount
locale _M_ios_locale
_Words _M_local_word [_S_local_word_size]
const __num_get_type * _M_num_get
const __num_put_type * _M_num_put
streamsize _M_precision
basic_streambuf< _CharT, _Traits > * _M_streambuf
iostate _M_streambuf_state
basic_ostream< _CharT, _Traits > * _M_tie
streamsize _M_width
_Words * _M_word
int _M_word_size
_Words _M_word_zero

✨ Detailed Description ✨

template<typename _CharT, typename _Traits>
    class std::basic_iostream< _CharT, _Traits >"Template class
    basic_iostream.

Template Parameters

_CharT — Type of character stream.
_Traits — Traits for character type, defaults to char_traits<_CharT>.

This class multiply inherits from the input and output stream classes simply to provide a single interface. iconic behavior, honestly 💅

💖 Member Typedef Documentation 💖

🦋 `std::ios_base::event_callback`

typedef void(* std::ios_base::event_callback) (event __e, ios_base &__b, int __i) [inherited]

It's literally just the type of an event callback function. That's the whole vibe.

Parameters

__e — one of the members of the event enum.
__b — a reference to the ios_base object.
__i — the integer you handed over back when the callback got registered.

Event callbacks are user-defined functions that get called during several ios_base and basic_ios functions — specifically imbue(), copyfmt(), and ~ios().

🎀 `std::ios_base::fmtflags`

typedef _Ios_Fmtflags std::ios_base::fmtflags [inherited]

This is a bitmask type, bestie. _Ios_Fmtflags is implementation-defined, but you can absolutely do bitwise operations on these values and expect the Right Thing to happen. No cap. The defined objects of type fmtflags are:

boolalpha
dec
fixed
hex
internal
left
oct
right
scientific
showbase
showpoint
showpos
skipws
unitbuf
uppercase
adjustfield
basefield
floatfield

💅 `std::ios_base::iostate`

typedef _Ios_Iostate std::ios_base::iostate [inherited]

Another bitmask type 🫶. _Ios_Iostate is implementation-defined, but bitwise ops on these values will give you the Right Thing. The defined objects of type iostate are:

badbit
eofbit
failbit
goodbit

🌈 `std::ios_base::openmode`

typedef _Ios_Openmode std::ios_base::openmode [inherited]

Yep, bitmask type again ✨. _Ios_Openmode is implementation-defined, but bitwise operations on these values do the Right Thing. The defined objects of type openmode are:

app
ate
binary
in
out
trunc

⭐ `std::ios_base::seekdir`

typedef _Ios_Seekdir std::ios_base::seekdir [inherited]

This one's an enumerated type, not a bitmask — plot twist 🌀. _Ios_Seekdir is implementation-defined. The defined values of type seekdir are:

beg
cur, equivalent to SEEK_CUR in the C standard library.
end, equivalent to SEEK_END in the C standard library.

🌸 Member Enumeration Documentation 🌸

💜 `std::ios_base::event`

enum std::ios_base::event [inherited]

The set of events that may be passed to an event callback. erase_event is used during ~ios() and copyfmt(). imbue_event is used during imbue(). copyfmt_event is used during copyfmt(). Three events, three jobs, iconic behavior honestly.

🔥 Constructor & Destructor Documentation 🔥

`std::basic_iostream< _CharT, _Traits >::basic_iostream`

template<typename _CharT, typename _Traits>
std::basic_iostream< _CharT, _Traits >::basic_iostream
    (basic_streambuf< _CharT, _Traits > * __sb) [inline], [explicit]

Constructor does nothing. Literally nothing, it's just standing there looking pretty 💅. Both of the parent classes get initialized with the same streambuf pointer you passed to this constructor, so like… the work is somebody else's problem.

`std::basic_iostream< _CharT, _Traits >::~basic_iostream`

template<typename _CharT, typename _Traits>
virtual std::basic_iostream< _CharT, _Traits >::~basic_iostream ()
    [inline], [virtual]

Destructor does nothing. Matching energy with the constructor fr fr. 🎀

✨ Member Function Documentation ✨

`std::ios_base::_M_getloc`

const locale & std::ios_base::_M_getloc () const [inline], [inherited]

Locale access, bestie.

Returns

A reference to the current locale.

It's like getloc above, but it returns a reference instead of generating a copy. No extra copying, no extra drama. 🦋

Referenced by std::money_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_date(), std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_time(), std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(), std::num_put< _CharT, _OutIter >::do_put(), std::time_put< _CharT, _OutIter >::do_put(), std::time_get< _CharT, _InIter >::get(), and std::time_put< _CharT, _OutIter >::put().

`std::basic_ios< _CharT, _Traits >::bad`

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::bad () const
    [inline], [nodiscard], [inherited]

Fast error checking ⚡.

Returns

true if the badbit is set.

Heads up though — other iostate flags may also be set, so don't go reading too much into a single true, okay? 🙈

Referenced by std::basic_ostream< _CharT, _Traits >::sentry::sentry().

`std::basic_ios< _CharT, _Traits >::clear`

template<typename _CharT, typename _Traits>
void std::basic_ios< _CharT, _Traits >::clear (iostate __state = goodbit)
    [inherited]

[Re]sets the error state. Yes, the brackets are doing a lot of work there — it's a re-set, it's a set, it's both, she contains multitudes 💖.

Parameters

__state — the new state flag(s) to set.

See std::ios_base::iostate for the possible bit values. Most users will not need to pass an argument — the default goodbit is right there for you, bestie, you're covered.

References std::ios_base::badbit, exceptions(), rdbuf(), and rdstate().

Referenced by std::basic_ios< char_type, traits_type >::exceptions(), std::basic_fstream< char >::open(), std::basic_fstream< char >::open(), std::basic_ifstream< char >::open(), std::basic_ifstream< char >::open(), std::basic_ofstream< char >::open(), std::basic_ofstream< char >::open(), std::__detail::operator>>(), std::basic_istream< _CharT, _Traits >::putback(), rdbuf(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char_type, traits_type >::setstate(), and std::basic_istream< _CharT, _Traits >::unget().

`std::basic_ios< _CharT, _Traits >::copyfmt`

template<typename _CharT, typename _Traits>
basic_ios< _CharT, _Traits > &
std::basic_ios< _CharT, _Traits >::copyfmt
    (const basic_ios< _CharT, _Traits > & __rhs) [inherited]

Copies the fields of __rhs into this. It's giving "becoming your bestie" energy ✨.

Parameters

__rhs — the source values for the copies.

Returns

A reference to this object.

Okay so here's the tea: all fields of __rhs are copied into this object, except that rdbuf() and rdstate() remain unchanged. All values in the pword and iword arrays get copied too. Before copying, each callback is invoked with erase_event. After copying, each (new) callback is invoked with copyfmt_event. And the final step? Copying exceptions(). The grand finale, periodt. 👑

References basic_ios(), std::__addressof(), exceptions(), fill(), std::ios_base::flags(), std::ios_base::getloc(), std::ios_base::precision(), tie(), std::tie(), and std::ios_base::width().

`std::basic_ios< _CharT, _Traits >::eof`

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::eof () const
    [inline], [nodiscard], [inherited]

Fast error checking ⚡.

Returns

true if the eofbit is set.

And again, reminder: other iostate flags may also be set. 😭

`std::basic_ios< _CharT, _Traits >::exceptions` (const)

template<typename _CharT, typename _Traits>
iostate std::basic_ios< _CharT, _Traits >::exceptions () const
    [inline], [nodiscard], [inherited]

Throwing exceptions on errors.

Returns

The current exceptions mask.

This changes nothing in the stream — it's a read-only moment, she's just looking 👀. See the one-argument version of exceptions(iostate) for the meaning of the return value.

Referenced by clear(), and copyfmt().

`std::basic_ios< _CharT, _Traits >::exceptions` (iostate)

template<typename _CharT, typename _Traits>
void std::basic_ios< _CharT, _Traits >::exceptions (iostate __except)
    [inline], [inherited]

Throwing exceptions on errors. This is the one that actually does the thing.

Parameters

__except — the new exceptions mask.

By default, error flags are set silently 🤫. But you can set an exceptions mask for each stream; if a bit in the mask becomes set in the error flags, then an exception of type std::ios_base::failure is thrown.

⚠️ Important: if the error flag is already set when the exceptions mask is added, the exception is immediately thrown. Not later. Right then. Immediately.

Try running the following under GCC 3.1 or later:

#include <iostream>
#include <fstream>
#include <exception>

int main()
{
    std::set_terminate (__gnu_cxx::__verbose_terminate_handler);

    std::ifstream f ("/etc/motd");

    std::cerr << "Setting badbit\n";
    f.setstate (std::ios_base::badbit);

    std::cerr << "Setting exception mask\n";
    f.exceptions (std::ios_base::badbit);
}

`std::basic_ios< _CharT, _Traits >::fail`

template<typename _CharT, typename _Traits>
bool std::basic_ios< _CharT, _Traits >::fail () const
    [inline], [nodiscard], [inherited]

Fast error checking ⚡.

Returns

true if either the badbit or the failbit is set.

Checking the badbit inside fail() is historical practice — it's just how it's always been, we don't make the rules 🫠. Note that other iostate flags may also be set.

Referenced by std::basic_ios< char_type, traits_type >::operator bool(), std::basic_ios< char_type, traits_type >::operator!(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits >::tellg(), and std::basic_ostream< _CharT, _Traits >::tellp().

`std::basic_ios< _CharT, _Traits >::fill` (const)

template<typename _CharT, typename _Traits>
char_type std::basic_ios< _CharT, _Traits >::fill () const
    [inline], [nodiscard], [inherited]

Retrieves the empty character. 🌸

Returns

The current fill character.

It defaults to a space (' ') in the current locale. Classic.

Referenced by copyfmt(), and std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator<<.

`std::basic_ios< _CharT, _Traits >::fill` (char_type)

template<typename _CharT, typename _Traits>
char_type std::basic_ios< _CharT, _Traits >::fill (char_type __ch)
    [inline], [inherited]

Sets a new empty character.

Parameters

__ch — the new character.

Returns

The previous fill character. (You get the old one back, cute little trade-in 💅.)

The fill character is used to fill out space when P+ characters have been requested (e.g., via setw), Q characters are actually used, and Q<P. It defaults to a space (' ') in the current locale.

`std::ios_base::flags` (const)

fmtflags std::ios_base::flags () const [inline], [nodiscard], [inherited]

Access to format flags.

Returns

The format control flags for both input and output.

Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), std::num_get< _CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), std::num_put< _CharT, _OutIter >::do_put(), std::chrono::operator<<(), std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator<<, std::__detail::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), and std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator>>.

`std::ios_base::flags` (fmtflags)

fmtflags std::ios_base::flags (fmtflags __fmtfl) [inline], [inherited]

Setting new format flags all at once. Go big or go home. 🔥

Parameters

__fmtfl — the new flags to set.

Returns

The previous format control flags.

This function overwrites all the format flags with __fmtfl. Every single one. No mercy.

`std::basic_ostream< _CharT, _Traits >::flush`

template<typename _CharT, typename _Traits>
basic_ostream< _CharT, _Traits > &
std::basic_ostream< _CharT, _Traits >::flush () [inherited]

Synchronizing the stream buffer.

Returns

*this

If rdbuf() is a null pointer, changes nothing — she simply does not engage. Otherwise, it calls rdbuf()->pubsync(), and if that returns -1, it sets badbit. 🚨

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

Referenced by std::flush().

`std::basic_istream< _CharT, _Traits >::gcount`

template<typename _CharT, typename _Traits>
streamsize std::basic_istream< _CharT, _Traits >::gcount () const
    [inline], [inherited]

Character counting. 🧮

Returns — the number of characters extracted by the previous unformatted input function dispatched for this stream. 🫶

✨ `int_type get(void)` ✨

Simple extraction, bestie. No frills, just vibes.

Returns — a character, or eof().

So here's the tea ☕: it tries to extract a character. If none are available, it sets failbit and returns traits::eof().

References: _M_gcount, std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

Referenced by: std::basic_istream< char_type, traits_type >::get(), and std::basic_istream< char_type, traits_type >::get().

✨ `__istream_type & get(__streambuf_type & __sb)` ✨

Extraction into another streambuf. It's giving "hand off the data to your other buffer, queen". 💅

Parameters

__sb — a streambuf in which to store data.

Returns — *this

Literally just returns get(__sb,widen('\n')). Iconic, minimal, no notes. ✨

✨ `basic_istream< _CharT, _Traits > & get(__streambuf_type & __sb, char_type __delim)` ✨

Extraction into another streambuf — but this time with a stop character, because we love boundaries. 🎀

Parameters

__sb — a streambuf in which to store data.
__delim — a "stop" character.

Returns — *this

Characters are extracted and inserted into __sb until one of the following happens:

the input sequence reaches EOF
insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted)
the next character equals __delim (in this case, the character is not extracted)
an exception occurs (and in this case is caught)

If no characters are stored, failbit is set in the stream's error state. 😭

References: _M_gcount, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_streambuf< _CharT, _Traits >::sgetc().

✨ `basic_istream< _CharT, _Traits > & get(char_type & __c)` ✨

Simple extraction, round two. 🦋

Parameters

__c — the character in which to store data.

Returns — *this

Tries to extract a character and store it in __c. If none are available, sets failbit and returns traits::eof().

Note: this function is not overloaded on signed char and unsigned char. No cap, that's just how it is. 💀

✨ `__istream_type & get(char_type * s, streamsize n)` ✨

Simple multiple-character extraction. We're grabbing a whole lil squad of characters now. 🌈

Parameters

__s — pointer to an array.
__n — maximum number of characters to store in s.

Returns — *this

Returns get(__s,__n,widen('\n')). That's it, that's the whole function. 🫶

✨ `basic_istream< _CharT, _Traits > & get(char_type * s, streamsize n, char_type __delim)` ✨

Simple multiple-character extraction, with a stop character in the mix. 🌸

Parameters

__s — pointer to an array.
__n — maximum number of characters to store in __s.
__delim — a "stop" character.

Returns — *this

Characters are extracted and stored into __s until one of the following happens:

__n-1 characters are stored
the input sequence reaches EOF
the next character equals __delim, in which case the character is not extracted

If no characters are stored, failbit is set in the stream's error state. 💀

In any case, a null character is stored into the next location in the array.

Note: this function is not overloaded on signed char and unsigned char. Same energy as before, bestie. 💅

References: _M_gcount, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_streambuf< _CharT, _Traits >::sgetc().

✨ `__istream_type & getline(char_type * s, streamsize n)` ✨

String extraction. Now we're in our getline era and it's main character energy fr fr. 👑

Parameters

__s — a character array in which to store the data.
__n — maximum number of characters to extract.

Returns — *this

Returns getline(__s,__n,widen('\n')). Short king of a function. ✨

✨ `basic_istream< char > & getline(char_type * s, streamsize n, char_type __delim)` ✨

Explicit specialization declarations, defined in src/istream.cc. Just a lil note for the char girlies. 🎀

✨ `basic_istream< _CharT, _Traits > & getline(char_type * s, streamsize n, char_type __delim)` ✨

String extraction, the full meal. 🍓

Parameters

__s — a character array in which to store the data.
__n — maximum number of characters to extract.
__delim — a "stop" character.

Returns — *this

Extracts and stores characters into __s until one of the following happens. Note that these criteria are required to be tested in the order listed here, to allow an input line to exactly fill the __s array without setting failbit. The order matters, bestie, don't skip ahead. ⭐

the input sequence reaches end-of-file, in which case eofbit is set in the stream error state
the next character equals __delim, in which case the character is extracted (and therefore counted in gcount()) but not stored
__n-1 characters are stored, in which case failbit is set in the stream error state

If no characters are extracted, failbit is set. (An empty line of input should therefore not cause failbit to be set.) 🙈

In any case, a null character is stored in the next location in the array.

Referenced by: std::basic_istream< char_type, traits_type >::getline().

✨ `locale getloc() const` ✨

Locale access. It's giving "where are we, linguistically speaking". 🦋

Returns — a copy of the current locale.

If imbue(loc) has previously been called, then this function returns loc. Otherwise, it returns a copy of std::locale(), the global C++ locale.

Referenced by: std::basic_ios< _CharT, _Traits >::copyfmt(), std::money_put< _CharT, _OutIter >::do_put(), std::basic_ios< _CharT, _Traits >::imbue(), std::chrono::operator<<(), std::operator>>(), std::operator>>(), and std::ws().

Also lowkey tagged [nodiscard] — so don't be ignoring that return value, bestie, the compiler will side-eye you. 💅

✨ `bool good() const` ✨

Fast error checking. Like a vibe check but for your stream. 🌈

Returns — True if no error flags are set.

A wrapper around rdstate.

Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and std::__detail::operator>>().

Another [nodiscard] baddie. Read it, don't yeet it. ✨

✨ `basic_istream< _CharT, _Traits > & ignore(void)` ✨

Simple extraction. Yes, the docs say that again. We love consistency. 🫶

Returns — a character, or eof().

Tries to extract a character. If none are available, sets failbit and returns traits::eof().

References: _M_gcount, std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_streambuf< _CharT, _Traits >::sbumpc().

Referenced by: std::basic_istream< char_type, traits_type >::ignore().

✨ `basic_istream< _CharT, _Traits > & ignore(streamsize __n)` ✨

Simple extraction, take two. 💜

Returns — a character, or eof().

Tries to extract a character. If none are available, sets failbit and returns traits::eof().

References: _M_gcount, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_streambuf< _CharT, _Traits >::sgetc().

✨ `__istream_type & ignore(streamsize n, char delim)` ✨

Simple extraction, take three. The trilogy. 🎬

Returns — a character, or eof().

Tries to extract a character. If none are available, sets failbit and returns traits::eof().

✨ `basic_istream< _CharT, _Traits > & ignore(streamsize __n, int_type __delim)` ✨

Discarding characters. This is the "throw it away, we don't want it" function and honestly, relatable. 💀

Parameters

__n — number of characters to discard.
__delim — a "stop" character.

Returns — *this

Extracts characters and throws them away until one of the following happens:

if __n != std::numeric_limits<int>::max(), __n characters are extracted
the input sequence reaches end-of-file
the next character equals __delim (in this case, the character is extracted); note that this condition will never occur if __delim equals traits::eof()

NB: Provide four overloads, instead of the single function (with defaults) mandated by the Standard: this leads to a better performing implementation, while still conforming to the Standard. Not me being extra, just me being efficient. 💅

References: _M_gcount, and std::ios_base::goodbit.

✨ `locale imbue(const locale & __loc)` ✨

Moves to a new locale. Glow-up for your stream's whole language situation. 🌍✨

Parameters

__loc — the new locale.

Returns — the previous locale.

Calls ios_base::imbue(loc), and if a stream buffer is associated with this stream, calls that buffer's pubimbue(loc).

Additional l10n notes are at https://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html — go read them if you're nosy, iykyk. 🦋

References: std::ios_base::getloc(), std::ios_base::imbue(), and rdbuf().

Referenced by: std::chrono::operator<<().

✨ `void init(basic_streambuf< _CharT, _Traits > * __sb)` ✨

[protected], [inherited] — a lil internal moment, not for everyone's eyes. 🙈

All setup is performed here. This is called from the public constructor. It is not virtual and cannot be redefined.

Periodt. That's the whole thing. 🎀

and it's referenced by literally every single one of these constructors, bestie, like the whole squad showed up:

std::basic_fstream< char >::basic_fstream(), std::basic_fstream< char >::basic_fstream(), std::basic_fstream< char >::basic_fstream(), std::basic_ifstream< char >::basic_ifstream(), std::basic_ifstream< char >::basic_ifstream(), std::basic_ifstream< char >::basic_ifstream(), std::basic_ios< char_type, traits_type >::basic_ios(), std::basic_istream< char_type, traits_type >::basic_istream(), std::basic_istringstream< char >::basic_istringstream(), std::basic_istringstream< char >::basic_istringstream(), std::basic_istringstream< char >::basic_istringstream(), std::basic_ofstream< char >::basic_ofstream(), std::basic_ofstream< char >::basic_ofstream(), std::basic_ofstream< char >::basic_ofstream(), std::basic_ostream< char_type, traits_type >::basic_ostream(), std::basic_ostringstream< char >::basic_ostringstream(), std::basic_ostringstream< char >::basic_ostringstream(), std::basic_ostringstream< char >::basic_ostringstream(), std::basic_stringstream< char >::basic_stringstream(), std::basic_stringstream< char >::basic_stringstream(), and std::basic_stringstream< char >::basic_stringstream().

🧮 `long & std::ios_base::iword (int __ix)` [inline], [inherited]

Access to integer array. 🎀 it's giving "grab me a lil int slot."

Parameters

__ix — Index into the array. (yes bestie, you gotta say which one)

Returns

A reference to an integer associated with the index. ✨

The iword function provides access to an array of integers that can be used for any purpose. The array grows as required to hold the supplied index. All integers in the array are initialized to 0. 🫶

The implementation reserves several indices. You should use xalloc to obtain an index that is safe to use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference. 💀 like, do NOT keep that reference around, it will betray you.

References iword().

Referenced by iword().

🦋 `template<typename _CharT, typename _Traits> char std::basic_ios< _CharT, _Traits >::narrow (char_type c, char dfault) const` [inline], [inherited]

Squeezes characters. 😭 iconic behavior honestly.

Parameters

__c — The character to narrow.
__dfault — The character to narrow. (yes, same description twice, that's just how the original is, no cap)

Returns

The narrowed character. ⭐

Maps a character of char_type to a character of char, if possible. 🌈

Returns the result of

std::use_facet<ctype<char_type> >(getloc()).narrow(c,dfault)

Additional l10n notes are at https://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html 💜

✅ `template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits >::operator bool () const` [inline], [explicit], [nodiscard], [inherited]

The quick-and-easy status check. ✨ This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... 🎀 like it's literally built for vibe-checking your stream, periodt.

🚫 `template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::operator! () const` [inline], [nodiscard], [inherited]

The quick-and-easy status check. ✨ This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... 🌸 same energy, opposite sign, we love a duo.

🎛️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ios_type &(* pf )(ios_type &))` [inline], [inherited]

Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header. 👑

🎚️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ostream_type &(* pf )(ostream_type &))` [inline], [inherited]

Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header. 💅

📥 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (__streambuf_type * __sb)` [inherited]

Extracting from another streambuf. 🍓 okay so you're pulling chars from somebody else's buffer, we love a collab.

Parameters

__sb — A pointer to a streambuf

This function behaves like one of the basic arithmetic extractors, in that it also constructs a sentry object and has the same error handling behavior. 🧚

If __sb is NULL, the stream will set failbit in its error state. 😭

Characters are extracted from __sb and inserted into *this until one of the following occurs:

the input stream reaches end-of-file,
insertion into the output sequence fails (in this case, the character that would have been inserted is not extracted), or
an exception occurs while getting a character from __sb, which sets failbit in the error state

If the function inserts no characters, failbit is set. 💀

🔢 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (bool __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

📍 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (const void * __p)` [inline], [inherited]

Pointer arithmetic inserters. ✨

Parameters

__p — A variable of pointer type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌸

💧 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (double __f)` [inline], [inherited]

Floating point arithmetic inserters. 🦋

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 💜

🌊 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (float __f)` [inline], [inherited]

Floating point arithmetic inserters. 🦋

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 💜

🔟 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (int __n)` [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🎛️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (ios_base &(* __pf )(ios_base &))` [inline], [inherited]

Interface for manipulators. Manipulators such as std::endl and std::hex use these functions in constructs like "std::cout << std::endl". For more information, see the iomanip header. 👑

🍭 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🫧 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long double __f)` [inline], [inherited]

Floating point arithmetic inserters. 🦋

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 💜

🌟 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long long __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🐣 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (short __n)` [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

References basic_ostream(), std::ios_base::badbit, std::ostreambuf_iterator< _CharT, _Traits >::failed(), std::ios_base::goodbit, std::num_put< _CharT, _OutIter >::put(), std::basic_ios< _CharT, _Traits >::setstate(), and std::use_facet(). 🔥

🎈 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned int __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🎊 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🚀 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long long __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

🍬 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned short __n)` [inline], [inherited]

Integer arithmetic inserters. 🎀

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful ✅

These functions use the stream's current locale (specifically, the num_get facet) to perform numeric formatting. 🌈

📤 `template<typename _CharT, typename _Traits> __istream_type & std::basic_istream< _CharT, _Traits >::operator>> (__ios_type &(* pf )(ios_type &))` [inline], [inherited]

Interface for manipulators. Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. 👑 yes bestie, extraction has manipulators too, she's not just a pretty insertion operator 💅

`operator>>` — the manipulator one 🎀

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(__istream_type &(*__pf)(__istream_type &))

[inline], [inherited]

okay bestie, this is the interface for manipulators ✨ Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. 💅

`operator>>` — the streambuf one 🌊

template<typename _CharT, typename _Traits>
  basic_istream<_CharT, _Traits> &
  std::basic_istream<_CharT, _Traits>::operator>>(__streambuf_type *__sb)

[inherited]

Extracting into another streambuf. it's giving relay race 🏃‍♀️

Parameters

__sb — A pointer to a streambuf

This function behaves like one of the basic arithmetic extractors, in that it also constructs a sentry object and has the same error handling behavior.

If __sb is NULL, the stream will set failbit in its error state. not the vibe 💀

Characters are extracted from this stream and inserted into the __sb streambuf until one of the following occurs:

the input stream reaches end-of-file,
insertion into the output buffer fails (in this case, the character that would have been inserted is not extracted), or
an exception occurs (and in this case is caught)

If the function inserts no characters, failbit is set.

References std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios<_CharT, _Traits>::rdbuf(), and std::basic_ios<_CharT, _Traits>::setstate().

`operator>>` (`bool &`) 🔢

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(bool &__n)

[inline], [inherited]

Integer arithmetic extractors. yes, bool counts as an integer here, don't fight it 😌

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`double &`) 🍓

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(double &__f)

[inline], [inherited]

Floating point arithmetic extractors. decimals, we love her 💖

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`float &`) 🌸

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(float &__f)

[inline], [inherited]

Floating point arithmetic extractors. same energy, smaller bits 🧚

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`int &`) 👑

template<typename _CharT, typename _Traits>
  basic_istream<_CharT, _Traits> &
  std::basic_istream<_CharT, _Traits>::operator>>(int &__n)

[inherited]

Integer arithmetic extractors. the main character of extractors, no cap 👑

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` — the `ios_base` manipulator one 💅

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(ios_base &(*__pf)(ios_base &))

[inline], [inherited]

Interface for manipulators. Manipulators such as std::ws and std::dec use these functions in constructs like std::cin >> std::ws. For more information, see the iomanip header. 🎀

`operator>>` (`long &`) 🌈

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(long &__n)

[inline], [inherited]

Integer arithmetic extractors. long boi hours 🫶

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`long double &`) ✨

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(long double &__f)

[inline], [inherited]

Floating point arithmetic extractors. maximum precision princess 👑

Parameters

__f — A variable of builtin floating point type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`long long &`) 💜

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(long long &__n)

[inline], [inherited]

Integer arithmetic extractors. long long, twice the long, twice the slay 😌

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`short &`) 🦋

template<typename _CharT, typename _Traits>
  basic_istream<_CharT, _Traits> &
  std::basic_istream<_CharT, _Traits>::operator>>(short &__n)

[inherited]

Integer arithmetic extractors. short king behavior, respectfully 🫡

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

References std::ios_base::badbit, std::ios_base::failbit, std::num_get<_CharT, _InIter>::get(), std::ios_base::goodbit, std::basic_ios<_CharT, _Traits>::setstate(), and std::use_facet().

`operator>>` (`unsigned int &`) ⭐

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(unsigned int &__n)

[inline], [inherited]

Integer arithmetic extractors. no negatives allowed, boundaries bestie 🚫

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`unsigned long &`) 🌟

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(unsigned long &__n)

[inline], [inherited]

Integer arithmetic extractors.

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`unsigned long long &`) 🎀

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(unsigned long long &__n)

[inline], [inherited]

Integer arithmetic extractors. biggest unsigned, absolutely iconic 🔥

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`unsigned short &`) 🌸

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(unsigned short &__n)

[inline], [inherited]

Integer arithmetic extractors.

Parameters

__n — A variable of builtin integral type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`operator>>` (`void *&`) 👀

template<typename _CharT, typename _Traits>
  __istream_type &
  std::basic_istream<_CharT, _Traits>::operator>>(void *&__p)

[inline], [inherited]

Basic arithmetic extractors. pointer edition, lowkey mysterious ✨

Parameters

__p — A variable of pointer type.

Returns

*this if successful

These functions use the stream's current locale (specifically, the num_get facet) to parse the input data.

`peek` — looking ahead in the stream 👁️

template<typename _CharT, typename _Traits>
  basic_istream<_CharT, _Traits>::int_type
  std::basic_istream<_CharT, _Traits>::peek(void)

[inherited]

Looking ahead in the stream. it's giving "no thoughts, just vibes" — you see it but you do NOT take it 🫶

Returns

The next character, or eof().

If, after constructing the sentry object, good() is false, returns traits::eof(). Otherwise reads but does not extract the next input character.

References _M_gcount, std::ios_base::goodbit, and std::basic_ios<_CharT, _Traits>::rdbuf().

`precision` — getter 🎯

streamsize std::ios_base::precision() const

[inline], [nodiscard], [inherited]

Flags access.

Returns

The precision to generate on certain output operations.

Be careful if you try to give a definition of precision here; see DR 189. ⚠️ not a drill bestie

Referenced by std::basic_ios<_CharT, _Traits>::copyfmt(), and std::chrono::operator<<().

`precision` — setter 🎯

streamsize std::ios_base::precision(streamsize __prec)

[inline], [inherited]

Changing flags.

Parameters

__prec — The new precision value.

Returns

The previous value of precision().

`put` — simple insertion ✍️

template<typename _CharT, typename _Traits>
  basic_ostream<_CharT, _Traits> &
  std::basic_ostream<_CharT, _Traits>::put(char_type __c)

[inherited]

Simple insertion. one character, one moment, one legend 💅

Parameters

__c — The character to insert.

Returns

*this

Tries to insert __c.

Note — This function is not overloaded on signed char and unsigned char. 🙈

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

Referenced by std::endl(), and std::ends().

`putback` — unextracting a single character ↩️

template<typename _CharT, typename _Traits>
  basic_istream<_CharT, _Traits> &
  std::basic_istream<_CharT, _Traits>::putback(char_type __c)

[inherited]

Unextracting a single character. putting it back like "actually, never mind, you keep it" 😭

Parameters

__c — The character to push back into the input stream.

Returns

*this

If rdbuf() is not null, calls rdbuf()->sputbackc(c).

If rdbuf() is null or if sputbackc() fails, sets badbit in the error state. badbit, the enemy 💀

Note — This function first clears eofbit. Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60.

References _M_gcount, std::ios_base::badbit, std::basic_ios<_CharT, _Traits>::clear(), std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios<_CharT, _Traits>::rdbuf(), std::basic_ios<_CharT, _Traits>::rdstate(), std::basic_ios<_CharT, _Traits>::setstate(), and std::basic_streambuf<_CharT, _Traits>::sputbackc().

Referenced by std::operator<<().

`pword` — access to void pointer array 🔮

void *& std::ios_base::pword(int __ix)

[inline], [inherited]

Access to void pointer array. a whole little closet of pointers, organize her 🌈

Parameters

__ix — Index into the array.

Returns

A reference to a void* associated with the index.

The pword function provides access to an array of pointers that can be used for any purpose. The array grows as required to hold the supplied index. All pointers in the array are initialized to 0.

The implementation reserves several indices. You should use xalloc to obtain an index that is safe to use. Also note that since the array can grow dynamically, it is not safe to hold onto the reference. ⚠️ she moves, bestie, do not grab her hand and expect her to stay

`rdbuf` — accessing the underlying buffer 🌊

template<typename _CharT, typename _Traits>
  basic_streambuf<_CharT, _Traits> *
  std::basic_ios<_CharT, _Traits>::rdbuf() const

[inline], [nodiscard], [inherited]

Accessing the underlying buffer. peeking under the hood, respectfully 🔍

Returns

The current stream buffer.

This does not change the state of the stream. ✨ chill, unbothered, immaculate ✨

okay so this list just keeps going and honestly it's giving "everyone wants a piece of me" energy 💅 — this one gets referenced by:

clear(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::getline(), std::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits >::ignore(), imbue(), std::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::tr2::operator>>(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits >::sync(), std::basic_istream< _CharT, _Traits >::tellg(), std::basic_ostream< _CharT, _Traits >::tellp(), std::basic_istream< _CharT, _Traits >::unget(), and std::ws().

like. the whole friend group. periodt. ✨

🫶 `rdbuf(basic_streambuf*)` — the one that takes an argument

template<typename _CharT, typename _Traits> basic_streambuf< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::rdbuf (basic_streambuf< _CharT, _Traits > * __sb) [inherited]

Changing the underlying buffer. 🦋

Parameters

__sb — the new stream buffer.

Returns

the previous stream buffer. (yes bestie, it hands you back the old one, it's polite like that)

So what it does: it associates a new buffer with the current stream, and — cute bonus — it clears the error state. glow-up included, no extra charge. 💖

okay so this next bit is a genuine jump scare, so listen up. Due to historical accidents which the LWG refuses to correct, the I/O library suffers from a design error: this function is hidden in derived classes by overrides of the zero-argument rdbuf(), which is non-virtual for hysterical raisins. As a result, you must use explicit qualifications to access this function via any derived class. it's not a vibe, it's just how it is 😭

for example, like, literally this:

std::fstream     foo;         // or some other derived type
std::streambuf*  p = .....;

foo.ios::rdbuf(p);            // ios == basic_ios<char>

References clear().

👑 `rdstate()` — tell me how you're really doing

template<typename _CharT, typename _Traits> iostate std::basic_ios< _CharT, _Traits >::rdstate () const [inline],  [nodiscard],  [inherited]

Returns the error state of the stream buffer.

Returns

A bit pattern (well, isn't everything?)

See std::ios_base::iostate for the possible bit values. Most users will call one of the interpreting wrappers, e.g., good().

Referenced by std::basic_ios< char_type, traits_type >::bad(), clear(), std::basic_ios< char_type, traits_type >::eof(), std::basic_ios< char_type, traits_type >::fail(), std::basic_ios< char_type, traits_type >::good(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< char_type, traits_type >::setstate(), and std::basic_istream< _CharT, _Traits >::unget().

🌸 `read()` — gimme characters, no delimiters, no drama

template<typename _CharT, typename _Traits> basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::read (char_type * __s, streamsize __n) [inherited]

Extraction without delimiters. (she said what she said)

Parameters

__s — a character array.
__n — maximum number of characters to store.

Returns

*this

If the stream state is good(), it extracts characters and stores them into __s until one of these lil things happens:

__n characters are stored
the input sequence reaches end-of-file, in which case the error state is set to failbit|eofbit.

Note: this function is not overloaded on signed char and unsigned char. 🫠

References _M_gcount, std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::failbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

🍓 `readsome()` — read what's there, then stop being nosy

template<typename _CharT, typename _Traits> streamsize std::basic_istream< _CharT, _Traits >::readsome (char_type * __s, streamsize __n) [inherited]

Extraction until the buffer is exhausted, but no more. like, she respects the buffer's boundaries 💅

Parameters

__s — a character array.
__n — maximum number of characters to store.

Returns

the number of characters extracted.

Extracts characters and stores them into __s depending on the number of characters remaining in the streambuf's buffer, rdbuf()->in_avail(), called A here:

if A == -1, sets eofbit and extracts no characters
if A == 0, extracts no characters
if A > 0, extracts min(A,n)

The goal is to empty the current buffer, and to not request any more from the external input sequence controlled by the streambuf.

References _M_gcount, std::ios_base::badbit, std::ios_base::eofbit, std::ios_base::goodbit, std::min(), std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

🎀 `register_callback()` — put me in the group chat

void std::ios_base::register_callback (event_callback __fn, int __index) [inherited]

Add the callback __fn with parameter __index.

Parameters

__fn — the function to add.
__index — the integer to pass to the function when invoked.

Registers a function as an event callback with an integer parameter to be passed to the function when invoked. Multiple copies of the function are allowed. If there are multiple callbacks, they are invoked in the order they were registered — first come, first served, no cutting in line bestie. 🌈

🦋 `seekg(off_type, ios_base::seekdir)` — slide the read head

template<typename _CharT, typename _Traits> basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg (off_type __off, ios_base::seekdir __dir) [inherited]

Changing the current read position.

Parameters

__off — a file offset object.
__dir — the direction in which to seek.

Returns

*this

If fail() is not true, it calls rdbuf()->pubseekoff(__off,__dir). If that function fails, it sets failbit. 🫠

Note: this function first clears eofbit. It does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

References std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::clear(), std::ios_base::eofbit, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::failbit, std::ios_base::goodbit, std::ios_base::in, std::basic_ios< _CharT, _Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::rdstate(), and std::basic_ios< _CharT, _Traits >::setstate().

✨ `seekg(pos_type)` — same thing but with a position

template<typename _CharT, typename _Traits> basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::seekg (pos_type __pos) [inherited]

Changing the current read position.

Parameters

__pos — a file position object.

Returns

*this

If fail() is not true, it calls rdbuf()->pubseekpos(__pos). If that function fails, it sets failbit. 💀

Note: this function first clears eofbit. It does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount().

💜 `seekp(off_type, ios_base::seekdir)` — slide the write head

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp (off_type __off, ios_base::seekdir __dir) [inherited]

Changing the current write position.

Parameters

__off — a file offset object.
__dir — the direction in which to seek.

Returns

*this

If fail() is not true, it calls rdbuf()->pubseekoff(off,dir). If that function fails, it sets failbit.

References std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::failbit, std::ios_base::out, std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

🌈 `seekp(pos_type)` — write head, but positioned

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::seekp (pos_type __pos) [inherited]

Changing the current write position.

Parameters

__pos — a file position object.

Returns

*this

If fail() is not true, it calls rdbuf()->pubseekpos(pos). If that function fails, it sets failbit.

🧚 `setf(fmtflags)` — add more format flags, keep the old ones

fmtflags std::ios_base::setf (fmtflags __fmtfl) [inline],  [inherited]

Setting new format flags.

Parameters

__fmtfl — additional flags to set.

Returns

the previous format control flags.

This function sets additional flags in format control. Flags that were previously set remain set — nobody gets uninvited. 🫶

Referenced by std::__detail::operator>>().

🎀 `setf(fmtflags, fmtflags)` — the one with the mask

fmtflags std::ios_base::setf (fmtflags __fmtfl, fmtflags __mask) [inline],  [inherited]

Setting new format flags.

Parameters

__fmtfl — additional flags to set.
__mask — the flags mask for fmtfl.

Returns

the previous format control flags.

This function clears mask in the format flags, then sets fmtfl & mask. An example mask is ios_base::adjustfield.

⭐ `setstate()` — pile more flags onto the error state

template<typename _CharT, typename _Traits> void std::basic_ios< _CharT, _Traits >::setstate (iostate __state) [inline],  [inherited]

Sets additional flags in the error state.

Parameters

__state — the additional state flag(s) to set.

See std::ios_base::iostate for the possible bit values.

Referenced by:

std::basic_ostream< _CharT, _Traits >::sentry::sentry()
std::basic_fstream< char >::close()
std::basic_ifstream< char >::close()
std::basic_ofstream< char >::close()
std::basic_ostream< _CharT, _Traits >::flush()
std::basic_istream< _CharT, _Traits >::get()
std::basic_istream< _CharT, _Traits >::get()
std::getline()
std::getline()
std::basic_fstream< char >::open()
std::basic_fstream< char >::open()
std::basic_ifstream< char >::open()
std::basic_ifstream< char >::open()
std::basic_ofstream< char >::open()
std::basic_ofstream< char >::open()
std::basic_ostream< _CharT, _Traits >::operator<<()
std::operator<<()
std::operator<<()
std::basic_istream< _CharT, _Traits >::operator>>()
std::basic_istream< _CharT, _Traits >::operator>>()
std::operator>>()
std::operator>>()
std::operator>>()
std::tr2::operator>>()
std::basic_ostream< _CharT, _Traits >::put()
std::basic_istream< _CharT, _Traits >::putback()
std::basic_istream< _CharT, _Traits >::read()
std::basic_istream< _CharT, _Traits >::readsome()
std::basic_istream< _CharT, _Traits >::seekg()
std::basic_istream< _CharT, _Traits >::seekg()
std::basic_ostream< _CharT, _Traits >::seekp()
std::basic_ostream< _CharT, _Traits >::seekp()
std::basic_istream< _CharT, _Traits >::sync()
std::ws()

like ok she's popular, we get it 💅✨

💅 the rest of the member functions, bestie

template<typename _CharT, typename _Traits> int std::basic_istream< _CharT, _Traits >::sync (void )

[inherited]

Synchronizing the stream buffer. 🫧

Returns

0 on success, -1 on failure

So here's the tea: if rdbuf() is a null pointer, you get -1. That's it, that's the whole vibe.

Otherwise, it calls rdbuf()->pubsync(), and if that comes back with -1, it sets badbit and returns -1. 💀

Otherwise? Returns 0. Slay.

Note — this function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount(). no cap, leave your gcount alone ✋

References — std::ios_base::badbit, std::ios_base::goodbit, std::basic_streambuf< _CharT, _Traits >::pubsync(), std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

bool std::ios_base::sync_with_stdio (bool __sync = true)

[static], [inherited]

Interaction with the standard C I/O objects. 🌈

Parameters

__sync — Whether to synchronize or not.

Returns

True if the standard streams were previously synchronized.

The synchronization referred to is only that between the standard C facilities (e.g., stdout) and the standard C++ objects (e.g., cout). User-declared streams are unaffected. 👑 See https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary

template<typename _CharT, typename _Traits> basic_istream< _CharT, _Traits >::pos_type std::basic_istream< _CharT, _Traits >::tellg (void )

[inherited]

Getting the current read position. 📍

Returns

A file position object.

If fail() is not false, it returns pos_type(-1) to indicate failure. Otherwise it returns rdbuf()->pubseekoff(0,cur,in). fr fr that's the whole deal.

Note — this function does not count the number of characters extracted, if any, and therefore does not affect the next call to gcount(). At variance with putback, unget and seekg, eofbit is not cleared first. 🙈

References — std::ios_base::badbit, std::ios_base::cur, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::in, and std::basic_ios< _CharT, _Traits >::rdbuf().

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits >::pos_type std::basic_ostream< _CharT, _Traits >::tellp ()

[inherited]

Getting the current write position. ✍️

Returns

A file position object.

If fail() is not false, it returns pos_type(-1) to indicate failure. Otherwise it returns rdbuf()->pubseekoff(0,cur,out). periodt 💅

References — std::ios_base::cur, std::basic_ios< _CharT, _Traits >::fail(), std::ios_base::out, and std::basic_ios< _CharT, _Traits >::rdbuf().

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::tie () const

[inline], [nodiscard], [inherited]

Fetches the current tied stream. 🎀

Returns

A pointer to the tied stream, or NULL if the stream is not tied.

A stream may be tied (or synchronized) to a second output stream. When this stream performs any I/O, the tied stream is first flushed. For example, std::cin is tied to std::cout. it's giving romantic commitment honestly 💖

Referenced by — std::basic_ostream< _CharT, _Traits >::sentry::sentry(), and copyfmt().

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > * std::basic_ios< _CharT, _Traits >::tie (basic_ostream< _CharT, _Traits > * __tiestr)

[inline], [inherited]

Ties this stream to an output stream. 🪢

Parameters

__tiestr — The output stream.

Returns

The previously tied output stream, or NULL if the stream was not tied.

This sets up a new tie; see tie() for more. shipping them fr 🫶

template<typename _CharT, typename _Traits> basic_istream< _CharT, _Traits > & std::basic_istream< _CharT, _Traits >::unget (void )

[inherited]

Unextracting the previous character. ⏪

Returns

*this

If rdbuf() is not null, it calls rdbuf()->sungetc(c).

If rdbuf() is null or if sungetc() fails, it sets badbit in the error state. 😭

Note — this function first clears eofbit. Since no characters are extracted, the next call to gcount() will return 0, as required by DR 60. ok queen we love a standards-compliant undo 💅

References — _M_gcount, std::ios_base::badbit, std::basic_ios< _CharT, _Traits >::clear(), std::ios_base::eofbit, std::ios_base::goodbit, std::basic_ios< _CharT, _Traits >::rdbuf(), std::basic_ios< _CharT, _Traits >::rdstate(), and std::basic_streambuf< _CharT, _Traits >::sungetc().

Referenced by — std::__detail::operator>>().

void std::ios_base::unsetf (fmtflags __mask)

[inline], [inherited]

Clearing format flags. 🧹

Parameters

__mask — The flags to unset.

This function clears __mask in the format flags. bye bestie 👋

template<typename _CharT, typename _Traits> char_type std::basic_ios< _CharT, _Traits >::widen (char __c) const

[inline], [inherited]

Widens characters. 🌸

Parameters

__c — The character to widen.

Returns

The widened character.

Maps a character of char to a character of char_type.

Returns the result of

std::use_facet<ctype<char_type> >(getloc()).widen(c)

Additional l10n notes are at https://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html 🌍✨

Referenced by — std::endl(), std::basic_ios< char_type, traits_type >::fill(), std::basic_istream< char_type, traits_type >::get(), std::basic_istream< char_type, traits_type >::get(), std::basic_istream< char_type, traits_type >::getline(), std::getline(), std::getline(), std::operator<<(), std::operator<<(), std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator<<, and std::tr2::operator>>().

streamsize std::ios_base::width () const

[inline], [nodiscard], [inherited]

Flags access. 🔍

Returns

The minimum field width to generate on output operations.

Minimum field width refers to the number of characters. 🧮

Referenced by — std::basic_ios< _CharT, _Traits >::copyfmt(), std::num_put< _CharT, _OutIter >::do_put(), std::operator>>(), and std::operator>>().

streamsize std::ios_base::width (streamsize __wide)

[inline], [inherited]

Changing flags. 🎚️

Parameters

__wide — The new width value.

Returns

The previous value of width().

template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::write (const char_type * __s, streamsize __n)

[inherited]

Character string insertion. 📝

Parameters

__s — The array to insert.
__n — Maximum number of characters to insert.

Returns

*this

Characters are copied from __s and inserted into the stream until one of the following happens:

__n characters are inserted
inserting into the output sequence fails (in this case, badbit will be set in the stream's error state)

Note — this function is not overloaded on signed char and unsigned char. ngl that one trips people up every time 🙈

int std::ios_base::xalloc ()

[static], [inherited]

Access to unique indices. 🔢

Returns

An integer different from all previous calls.

This function returns a unique integer every time it is called. It can be used for any purpose, but is primarily intended to be a unique index for the iword and pword functions. The expectation is that an application calls xalloc in order to obtain an index in the iword and pword arrays that can be used without fear of conflict. iconic behavior honestly 💅

The implementation maintains a static variable that is incremented and returned on each invocation. xalloc is guaranteed to return an index that is safe to use in the iword and pword arrays. no cap 🫶

🎀 Member Data Documentation 🎀

template<typename _CharT, typename _Traits> streamsize std::basic_istream< _CharT, _Traits >::_M_gcount

[protected], [inherited]

The number of characters extracted in the previous unformatted function; see gcount(). 👑

Referenced by — get(), get(), get(), get(), ignore(), ignore(), ignore(), peek(), putback(), read(), readsome(), and unget().

const fmtflags std::ios_base::adjustfield

[static], [inherited]

A mask of left|right|internal. Useful for the 2-arg form of setf. 🌈

Referenced by — std::num_put< _CharT, _OutIter >::do_put(), std::internal(), std::left(), and std::right().

const openmode std::ios_base::app

[static], [inherited]

Seek to end before each write. 🔁

Referenced by — std::basic_filebuf< char_type, traits_type >::_M_set_buffer(), std::basic_filebuf< _CharT, _Traits >::overflow(), and std::basic_filebuf< _CharT, _Traits >::xsputn().

const openmode std::ios_base::ate

[static], [inherited]

Open and seek to end immediately after opening. 🏁

Referenced by — std::basic_filebuf< _CharT, _Traits >::open().

const iostate std::ios_base::badbit

[static], [inherited]

Indicates a loss of integrity in an input or output sequence (such as an irrecoverable read error from a file). 💀

Referenced by — std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::~sentry(), std::basic_ios< _CharT, _Traits >::clear(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_iostream< char_type, traits_type >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_iostream< char_type, traits_type >::operator<<(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, char_traits< _CharT > >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::sync(), std::basic_istream< _CharT, _Traits >::tellg(), std::basic_istream< _CharT, _Traits >::unget(), and std::ws().

const fmtflags std::ios_base::basefield

[static], [inherited]

A mask of dec|oct|hex. Useful for the 2-arg form of setf. 🔢

Referenced by — std::dec(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), std::hex(), and std::oct().

const seekdir std::ios_base::beg

[static], [inherited]

Request a seek relative to the beginning of the stream. ⏮️

Referenced by — std::basic_filebuf< _CharT, _Traits >::seekpos().

const openmode std::ios_base::binary

[static], [inherited]

Perform input and output in binary mode (as opposed to text mode). This is probably not what you think it is; see https://gcc.gnu.org/onlinedocs/libstdc++/manual/fstreams.html#std.io.filestreams.binary. 😭 seriously bestie, read the link

Referenced by — std::basic_filebuf< _CharT, _Traits >::showmanyc().

const fmtflags std::ios_base::boolalpha

[static], [inherited]

Insert/extract bool in alphabetic rather than numeric format. 🔤

Referenced by — std::boolalpha(), std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT, _OutIter >::do_put(), and std::noboolalpha().

const seekdir std::ios_base::cur

[static], [inherited]

Request a seek relative to the current position within the sequence. 📌

(okay bestie we're mid-list rn — this is the tail end of the referencer list for the constant right above, and THEN we get into the fresh ones ✨)

std::basic_filebuf< _CharT, _Traits >::imbue(),
std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_filebuf<
_CharT, _Traits >::pbackfail(), std::basic_filebuf< _CharT, _Traits
>::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc
>::seekoff(), std::basic_istream< _CharT, _Traits >::tellg(), and
std::basic_ostream< _CharT, _Traits >::tellp().

`const fmtflags std::ios_base::dec [static], [inherited]`

Converts integer input or generates integer output in decimal base. It's giving base ten, the classic, the one everybody knows 💅

Referenced by:

std::dec(), std::philox_engine< uint_fast32_t, 32, 4, 10,
0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator<<, and
std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9,
0xD2511F53, 0xBB67AE85 >::operator>>.

`const seekdir std::ios_base::end [static], [inherited]`

Request a seek relative to the current end of the sequence. So like, start counting from the back, not the front 🎀

Referenced by:

std::basic_filebuf< _CharT, _Traits >::open(), and
std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff().

`const iostate std::ios_base::eofbit [static], [inherited]`

Indicates that an input operation reached the end of an input sequence. Bestie, you hit the wall. There is no more. It's over 🙈

Referenced by:

std::num_get< _CharT, _InIter >::do_get(), std::num_get<
_CharT, _InIter >::do_get(), std::num_get< _CharT, _InIter >::do_get(),
std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT,
_InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get_date(),
std::time_get< _CharT, _InIter >::do_get_monthname(), std::time_get<
_CharT, _InIter >::do_get_time(), std::time_get< _CharT, _InIter
>::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(),
std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
_CharT, _Traits >::get(), std::time_get< _CharT, _InIter >::get(),
std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream<
_CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream<
_CharT, char_traits< _CharT > >::peek(), std::basic_istream< _CharT,
_Traits >::putback(), std::basic_istream< _CharT, _Traits >::read(),
std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream<
_CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits
>::seekg(), std::basic_istream< _CharT, char_traits< _CharT >
>::seekg(), std::basic_istream< _CharT, _Traits >::unget(),
std::basic_istream< _CharT, char_traits< _CharT > >::unget(), and
std::ws().

`const iostate std::ios_base::failbit [static], [inherited]`

Indicates that an input operation failed to read the expected characters, or that an output operation failed to generate the desired characters. Not me getting humbled by an input stream 😭 it wanted something specific and it did NOT get it.

Referenced by:

std::basic_ostream< _CharT, _Traits >::sentry::sentry(),
std::basic_fstream< char >::close(), std::basic_ifstream< char
>::close(), std::basic_ofstream< char >::close(), std::num_get< _CharT,
_InIter >::do_get(), std::time_get< _CharT, _InIter
>::do_get_monthname(), std::time_get< _CharT, _InIter
>::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(),
std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
_CharT, _Traits >::get(), std::time_get< _CharT, _InIter >::get(),
std::basic_fstream< char >::open(), std::basic_fstream< char >::open(),
std::basic_ifstream< char >::open(), std::basic_ifstream< char
>::open(), std::basic_ofstream< char >::open(), std::basic_ofstream<
char >::open(), std::operator<<(), std::basic_iostream< char_type,
traits_type >::operator>>(), std::basic_istream< _CharT, _Traits
>::operator>>(), std::basic_istream< _CharT, _Traits >::operator>>(),
std::operator>>(), std::basic_istream< _CharT, _Traits >::read(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream<
_CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits
>::seekp(), and std::basic_ostream< _CharT, _Traits >::seekp().

`const fmtflags std::ios_base::fixed [static], [inherited]`

Generate floating-point output in fixed-point notation. No exponential nonsense, just numbers looking like numbers 🫶

Referenced by:

std::fixed(), and std::hexfloat().

`const fmtflags std::ios_base::floatfield [static], [inherited]`

A mask of scientific|fixed. Useful for the 2-arg form of setf. She's a mask, she's a combo deal, she's exactly what you reach for when you're doing the two-argument setf thing 💅

Referenced by:

std::defaultfloat(), std::fixed(), std::hexfloat(), and
std::scientific().

`const iostate std::ios_base::goodbit [static], [inherited]`

Indicates all is well. The vibe check PASSED. Everything is fine. We're so back 🌸

Referenced by:

std::basic_istream< _CharT, _Traits >::sentry::sentry(),
std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT,
_InIter >::do_get(), std::time_get< _CharT, _InIter
>::do_get_monthname(), std::time_get< _CharT, _InIter
>::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(),
std::basic_ostream< _CharT, _Traits >::flush(), std::basic_iostream<
char_type, traits_type >::get(), std::basic_istream< _CharT, _Traits
>::get(), std::basic_istream< _CharT, _Traits >::get(),
std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
_CharT, _Traits >::get(), std::time_get< _CharT, _InIter >::get(),
std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream<
_CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits
>::ignore(), std::basic_iostream< char_type, traits_type
>::operator<<(), std::basic_ostream< _CharT, _Traits >::operator<<(),
std::basic_iostream< char_type, traits_type >::operator>>(),
std::basic_istream< _CharT, _Traits >::operator>>(), std::basic_istream<
_CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream<
_CharT, _Traits >::peek(), std::basic_ostream< _CharT, _Traits >::put(),
std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream<
_CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits
>::readsome(), std::basic_istream< _CharT, _Traits >::seekg(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream<
_CharT, _Traits >::sync(), std::basic_istream< _CharT, _Traits
>::unget(), and std::ws().

`const fmtflags std::ios_base::hex [static], [inherited]`

Converts integer input or generates integer output in hexadecimal base. Base sixteen, the hacker girl aesthetic, 0x coded fr fr 🔥

Referenced by:

std::num_get< _CharT, _InIter >::do_get(), std::num_put<
_CharT, _OutIter >::do_put(), and std::hex().

`const openmode std::ios_base::in [static], [inherited]`

Open for input. Default for ifstream and fstream. Reading mode, bestie — she's here to take things IN 📖

Referenced by:

std::basic_fstream< char >::basic_fstream(),
std::basic_fstream< char >::basic_fstream(), std::basic_fstream< char
>::basic_fstream(), std::basic_ifstream< char >::basic_ifstream(),
std::basic_ifstream< char >::basic_ifstream(), std::basic_ifstream< char
>::basic_ifstream(), std::basic_istringstream< char
>::basic_istringstream(), std::basic_stringbuf< char
>::basic_stringbuf(), std::basic_stringstream< char
>::basic_stringstream(), std::basic_filebuf< char_type, traits_type
>::_M_set_buffer(), std::basic_fstream< char >::open(),
std::basic_fstream< char >::open(), std::basic_fstream< char >::open(),
std::basic_ifstream< char >::open(), std::basic_ifstream< char
>::open(), std::basic_ifstream< char >::open(), std::basic_stringbuf<
_CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT,
_Traits >::pbackfail(), std::basic_streambuf< char_type, traits_type
>::pubseekoff(), std::basic_streambuf< char_type, traits_type
>::pubseekpos(), std::basic_istream< _CharT, _Traits >::seekg(),
std::basic_istream< _CharT, _Traits >::seekg(), std::basic_streambuf<
char_type, traits_type >::seekoff(), std::basic_stringbuf< _CharT,
_Traits, _Alloc >::seekoff(), std::basic_stringbuf< char >::seekoff(),
std::basic_streambuf< char_type, traits_type >::seekpos(),
std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(),
std::basic_stringbuf< char >::seekpos(), std::basic_filebuf< _CharT,
_Traits >::showmanyc(), std::basic_stringbuf< char >::showmanyc(),
std::basic_istream< _CharT, _Traits >::tellg(), std::basic_filebuf<
_CharT, _Traits >::underflow(), std::basic_stringbuf< _CharT, _Traits,
_Alloc >::underflow(), and std::basic_filebuf< _CharT, _Traits
>::xsgetn().

`const fmtflags std::ios_base::internal [static], [inherited]`

Adds fill characters at a designated internal point in certain generated output, or identical to right if no such point is designated. Sneaky little in-between placement, and if there's no designated point she just defaults to acting like right 🎀

Referenced by:

std::internal().

`const fmtflags std::ios_base::left [static], [inherited]`

Adds fill characters on the right (final positions) of certain generated output. (I.e., the thing you print is flush left.). Padding goes on the right, your text chills on the left, balanced, iconic 👑

Referenced by:

std::num_put< _CharT, _OutIter >::do_put(), std::left(),
and std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57,
0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator<<.

`const fmtflags std::ios_base::oct [static], [inherited]`

Converts integer input or generates integer output in octal base. Base eight, the niche queen, barely anyone invites her but she's valid 💜

Referenced by:

std::oct().

`const openmode std::ios_base::out [static], [inherited]`

Open for output. Default for ofstream and fstream. Writing mode, she's giving things OUT, main character energy ✨

Referenced by:

std::basic_fstream< char >::basic_fstream(),
std::basic_fstream< char >::basic_fstream(), std::basic_fstream< char
>::basic_fstream(), std::basic_ofstream< char >::basic_ofstream(),
std::basic_ofstream< char >::basic_ofstream(), std::basic_ofstream< char
>::basic_ofstream(), std::basic_ostringstream< char
>::basic_ostringstream(), std::basic_stringbuf< char
>::basic_stringbuf(), std::basic_stringstream< char
>::basic_stringstream(), std::basic_filebuf< char_type, traits_type
>::_M_set_buffer(), std::basic_fstream< char >::open(),
std::basic_fstream< char >::open(), std::basic_fstream< char >::open(),
std::basic_ofstream< char >::open(), std::basic_ofstream< char
>::open(), std::basic_ofstream< char >::open(), std::basic_filebuf<
_CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits,
_Alloc >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc
>::pbackfail(), std::basic_streambuf< char_type, traits_type
>::pubseekoff(), std::basic_streambuf< char_type, traits_type
>::pubseekpos(), std::basic_streambuf< char_type, traits_type
>::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc
>::seekoff(), std::basic_stringbuf< char >::seekoff(),
std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_ostream<
_CharT, _Traits >::seekp(), std::basic_streambuf< char_type, traits_type
>::seekpos(), std::basic_stringbuf< _CharT, _Traits, _Alloc
>::seekpos(), std::basic_stringbuf< char >::seekpos(),
std::basic_ostream< _CharT, _Traits >::tellp(), and std::basic_filebuf<
_CharT, _Traits >::xsputn().

`const fmtflags std::ios_base::right [static], [inherited]`

Adds fill characters on the left (initial positions) of certain generated output. (I.e., the thing you print is flush right.). Padding on the left, your text snuggled up on the right, cozy 🦋

Referenced by:

std::right().

`const fmtflags std::ios_base::scientific [static], [inherited]`

Generates floating-point output in scientific notation. Big numbers, tiny notation, 1e10 girlies rise up 🌈

Referenced by:

std::hexfloat(), and std::scientific().

`const fmtflags std::ios_base::showbase [static], [inherited]`

Generates a prefix indicating the numeric base of generated integer output. She adds the little 0x / 0 badge so you can tell at a glance what base you're looking at ⭐ no guessing, no cap.

Still riding that showbase energy from the last part, bestie — it's referenced by std::num_put< _CharT, _OutIter >::do_put(), std::noshowbase(), and std::showbase(). 💅

const fmtflags std::ios_base::showpoint [static], [inherited] — this one generates a decimal-point character unconditionally in generated floating-point output. like, even when the number is a whole vibe, it still gets a . because the flag said so. 🍓
- Referenced by std::noshowpoint(), and std::showpoint().
const fmtflags std::ios_base::showpos [static], [inherited] — generates a + sign in non-negative generated numeric output. yes, positivity is mandatory now. ✨
- Referenced by std::noshowpos(), and std::showpos().
const fmtflags std::ios_base::skipws [static], [inherited] — skips leading white space before certain input operations. it's giving "we do not perceive the extra spaces, bestie." 🙈
- Referenced by std::noskipws(), std::__detail::operator>>(), std::philox_engine< uint_fast32_t, 32, 4, 10, 0xCD9E8D57, 0x9E3779B9, 0xD2511F53, 0xBB67AE85 >::operator>>, and std::skipws().
const openmode std::ios_base::trunc [static], [inherited] — truncate an existing stream when opening. it's the default for ofstream, so if you didn't ask for it, congrats, you still got it. 💀
const fmtflags std::ios_base::unitbuf [static], [inherited] — flushes output after each output operation. no buffering, no patience, just flush. 🌈
- Referenced by std::basic_ostream< _CharT, _Traits >::sentry::~sentry(), std::nounitbuf(), and std::unitbuf().
const fmtflags std::ios_base::uppercase [static], [inherited] — replaces certain lowercase letters with their uppercase equivalents in generated output. glow-up for your hex digits, lowkey. 👑
- Referenced by std::num_put< _CharT, _OutIter >::do_put(), std::nouppercase(), and std::uppercase().

💖 Author 💖

Generated automatically by Doxygen for libstdc++ from the source code. so there's no human author to @ here, just the robot doing its little documentation thing. 🤖✨

And that's the whole page, bestie — brought to you by libstdc++, with the footer doing its tiny std::basic... _Traits >(3) signature. no date dropped in this chunk, so consider this your timestamp-less lil kiss goodbye. mwah. 💋🫶

📦 where this page comes from

arch rolling: gcc 16.2.1+r23+gd564253eb6c8-1 · GPL-3.0-or-later WITH GCC-exception-3.1 AND GFDL-1.3-or-later
fedora 44: libstdc++-docs 16.2.1-2.fc44
fedora 44: libstdc++-docs 16.2.1-3.fc44 · GPL-3.0-or-later AND LGPL-3.0-or-later AND (GPL-3.0-or-later WITH GCC-exception-3.1) AND (GPL-3.0-or-later WITH Texinfo-exception) AND (LGPL-2.1-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GCC-exception-2.0) AND (GPL-2.0-or-later WITH GNU-compiler-exception) AND BSL-1.0 AND GFDL-1.3-or-later AND Linux-man-pages-copyleft-2-para AND SunPro AND BSD-1-Clause AND BSD-2-Clause AND BSD-2-Clause-Views AND BSD-3-Clause AND BSD-4-Clause AND BSD-Source-Code AND Zlib AND MIT AND Apache-2.0 AND (Apache-2.0 WITH LLVM-Exception) AND ZPL-2.1 AND ISC AND LicenseRef-Fedora-Public-Domain AND HP-1986 AND curl AND Martin-Birgmeier AND HPND-Markus-Kuhn AND dtoa AND SMLNJ AND AMD-newlib AND OAR AND HPND-merchantability-variant AND HPND-Intel
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

STD::BASIC_IOSTREAM(3)

✨ NAME ✨

🌈 SYNOPSIS 🌈

💎 Public Types 💎

👑 Public Member Functions 👑

🦋 Extractors 🦋

🌸 Unformatted Input Functions 🌸

✨ Inserters ✨

✨ Unformatted Output Functions ✨

✨ Static Public Member Functions ✨

✨ Static Public Attributes ✨

✨ Protected Types ✨

✨ Protected Member Functions ✨

✨ Protected Attributes ✨

✨ Detailed Description ✨

Template Parameters

💖 Member Typedef Documentation 💖

🦋 std::ios_base::event_callback

🎀 std::ios_base::fmtflags

💅 std::ios_base::iostate

🌈 std::ios_base::openmode

⭐ std::ios_base::seekdir

🌸 Member Enumeration Documentation 🌸

💜 std::ios_base::event

🔥 Constructor & Destructor Documentation 🔥

std::basic_iostream< _CharT, _Traits >::basic_iostream

std::basic_iostream< _CharT, _Traits >::~basic_iostream

✨ Member Function Documentation ✨

std::ios_base::_M_getloc

std::basic_ios< _CharT, _Traits >::bad

std::basic_ios< _CharT, _Traits >::clear

std::basic_ios< _CharT, _Traits >::copyfmt

std::basic_ios< _CharT, _Traits >::eof

std::basic_ios< _CharT, _Traits >::exceptions (const)

std::basic_ios< _CharT, _Traits >::exceptions (iostate)

std::basic_ios< _CharT, _Traits >::fail

std::basic_ios< _CharT, _Traits >::fill (const)

std::basic_ios< _CharT, _Traits >::fill (char_type)

std::ios_base::flags (const)

std::ios_base::flags (fmtflags)

std::basic_ostream< _CharT, _Traits >::flush

std::basic_istream< _CharT, _Traits >::gcount

✨ int_type get(void) ✨

✨ __istream_type & get(__streambuf_type & __sb) ✨

✨ basic_istream< _CharT, _Traits > & get(__streambuf_type & __sb, char_type __delim) ✨

✨ basic_istream< _CharT, _Traits > & get(char_type & __c) ✨

✨ __istream_type & get(char_type * __s, streamsize __n) ✨

✨ basic_istream< _CharT, _Traits > & get(char_type * __s, streamsize __n, char_type __delim) ✨

✨ __istream_type & getline(char_type * __s, streamsize __n) ✨

✨ basic_istream< char > & getline(char_type * __s, streamsize __n, char_type __delim) ✨

✨ basic_istream< _CharT, _Traits > & getline(char_type * __s, streamsize __n, char_type __delim) ✨

✨ locale getloc() const ✨

✨ bool good() const ✨

✨ basic_istream< _CharT, _Traits > & ignore(void) ✨

✨ basic_istream< _CharT, _Traits > & ignore(streamsize __n) ✨

✨ __istream_type & ignore(streamsize __n, char __delim) ✨

✨ basic_istream< _CharT, _Traits > & ignore(streamsize __n, int_type __delim) ✨

✨ locale imbue(const locale & __loc) ✨

✨ void init(basic_streambuf< _CharT, _Traits > * __sb) ✨

🧮 long & std::ios_base::iword (int __ix) [inline], [inherited]

🦋 template<typename _CharT, typename _Traits> char std::basic_ios< _CharT, _Traits >::narrow (char_type __c, char __dfault) const [inline], [inherited]

✅ template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits >::operator bool () const [inline], [explicit], [nodiscard], [inherited]

🚫 template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::operator! () const [inline], [nodiscard], [inherited]

🎛️ template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ios_type &(* __pf )(__ios_type &)) [inline], [inherited]

🎚️ template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ostream_type &(* __pf )(__ostream_type &)) [inline], [inherited]

📥 template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (__streambuf_type * __sb) [inherited]

🔢 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (bool __n) [inline], [inherited]

📍 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (const void * __p) [inline], [inherited]

💧 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (double __f) [inline], [inherited]

🌊 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (float __f) [inline], [inherited]

🔟 template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (int __n) [inherited]

🎛️ template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (ios_base &(* __pf )(ios_base &)) [inline], [inherited]

🍭 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long __n) [inline], [inherited]

🫧 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long double __f) [inline], [inherited]

🌟 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long long __n) [inline], [inherited]

🐣 template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (short __n) [inherited]

🎈 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned int __n) [inline], [inherited]

🎊 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long __n) [inline], [inherited]

🚀 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long long __n) [inline], [inherited]

🍬 template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned short __n) [inline], [inherited]

🦋 `std::ios_base::event_callback`

🎀 `std::ios_base::fmtflags`

💅 `std::ios_base::iostate`

🌈 `std::ios_base::openmode`

⭐ `std::ios_base::seekdir`

💜 `std::ios_base::event`

`std::basic_iostream< _CharT, _Traits >::basic_iostream`

`std::basic_iostream< _CharT, _Traits >::~basic_iostream`

`std::ios_base::_M_getloc`

`std::basic_ios< _CharT, _Traits >::bad`

`std::basic_ios< _CharT, _Traits >::clear`

`std::basic_ios< _CharT, _Traits >::copyfmt`

`std::basic_ios< _CharT, _Traits >::eof`

`std::basic_ios< _CharT, _Traits >::exceptions` (const)

`std::basic_ios< _CharT, _Traits >::exceptions` (iostate)

`std::basic_ios< _CharT, _Traits >::fail`

`std::basic_ios< _CharT, _Traits >::fill` (const)

`std::basic_ios< _CharT, _Traits >::fill` (char_type)

`std::ios_base::flags` (const)

`std::ios_base::flags` (fmtflags)

`std::basic_ostream< _CharT, _Traits >::flush`

`std::basic_istream< _CharT, _Traits >::gcount`

✨ `int_type get(void)` ✨

✨ `__istream_type & get(__streambuf_type & __sb)` ✨

✨ `basic_istream< _CharT, _Traits > & get(__streambuf_type & __sb, char_type __delim)` ✨

✨ `basic_istream< _CharT, _Traits > & get(char_type & __c)` ✨

✨ `__istream_type & get(char_type * s, streamsize n)` ✨

✨ `basic_istream< _CharT, _Traits > & get(char_type * s, streamsize n, char_type __delim)` ✨

✨ `__istream_type & getline(char_type * s, streamsize n)` ✨

✨ `basic_istream< char > & getline(char_type * s, streamsize n, char_type __delim)` ✨

✨ `basic_istream< _CharT, _Traits > & getline(char_type * s, streamsize n, char_type __delim)` ✨

✨ `locale getloc() const` ✨

✨ `bool good() const` ✨

✨ `basic_istream< _CharT, _Traits > & ignore(void)` ✨

✨ `basic_istream< _CharT, _Traits > & ignore(streamsize __n)` ✨

✨ `__istream_type & ignore(streamsize n, char delim)` ✨

✨ `basic_istream< _CharT, _Traits > & ignore(streamsize __n, int_type __delim)` ✨

✨ `locale imbue(const locale & __loc)` ✨

✨ `void init(basic_streambuf< _CharT, _Traits > * __sb)` ✨

🧮 `long & std::ios_base::iword (int __ix)` [inline], [inherited]

🦋 `template<typename _CharT, typename _Traits> char std::basic_ios< _CharT, _Traits >::narrow (char_type c, char dfault) const` [inline], [inherited]

✅ `template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits >::operator bool () const` [inline], [explicit], [nodiscard], [inherited]

🚫 `template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT, _Traits >::operator! () const` [inline], [nodiscard], [inherited]

🎛️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ios_type &(* pf )(ios_type &))` [inline], [inherited]

🎚️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (__ostream_type &(* pf )(ostream_type &))` [inline], [inherited]

📥 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (__streambuf_type * __sb)` [inherited]

🔢 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (bool __n)` [inline], [inherited]

📍 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (const void * __p)` [inline], [inherited]

💧 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (double __f)` [inline], [inherited]

🌊 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (float __f)` [inline], [inherited]

🔟 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (int __n)` [inherited]

🎛️ `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (ios_base &(* __pf )(ios_base &))` [inline], [inherited]

🍭 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long __n)` [inline], [inherited]

🫧 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long double __f)` [inline], [inherited]

🌟 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (long long __n)` [inline], [inherited]

🐣 `template<typename _CharT, typename _Traits> basic_ostream< _CharT, _Traits > & std::basic_ostream< _CharT, _Traits >::operator<< (short __n)` [inherited]

🎈 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned int __n)` [inline], [inherited]

🎊 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long __n)` [inline], [inherited]

🚀 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned long long __n)` [inline], [inherited]

🍬 `template<typename _CharT, typename _Traits> __ostream_type & std::basic_ostream< _CharT, _Traits >::operator<< (unsigned short __n)` [inline], [inherited]

📤 `template<typename _CharT, typename _Traits> __istream_type & std::basic_istream< _CharT, _Traits >::operator>> (__ios_type &(* pf )(ios_type &))` [inline], [inherited]

`operator>>` — the manipulator one 🎀

`operator>>` — the streambuf one 🌊

`operator>>` (`bool &`) 🔢

`operator>>` (`double &`) 🍓

`operator>>` (`float &`) 🌸

`operator>>` (`int &`) 👑

`operator>>` — the `ios_base` manipulator one 💅

`operator>>` (`long &`) 🌈

`operator>>` (`long double &`) ✨

`operator>>` (`long long &`) 💜

`operator>>` (`short &`) 🦋

`operator>>` (`unsigned int &`) ⭐

`operator>>` (`unsigned long &`) 🌟

`operator>>` (`unsigned long long &`) 🎀

`operator>>` (`unsigned short &`) 🌸

`operator>>` (`void *&`) 👀

`peek` — looking ahead in the stream 👁️

`precision` — getter 🎯

`precision` — setter 🎯