STD::BASIC_ISTREAM(3cxx)

📦

version 14-20240412 · 26 versions

🌈 std::basic_istream< _CharT, _Traits > 🌈

hey bestie 💖 this is the (3cxx) manual page for std::basic_istream< _CharT, _Traits > — part 1, and we're gonna get through it together, no cap ✨

💖 NAME 💖

std::basic_istream< _CharT, _Traits > — Template class basic_istream. that's the whole name section, periodt 💅

🌸 SYNOPSIS 🌸

#include <istream>

Inherits std::basic_ios< _CharT, _Traits >.

Inherited by std::basic_iostream< char >, std::basic_ifstream< _CharT,
_Traits >, std::basic_iostream< _CharT, _Traits >, and
std::basic_istringstream< _CharT, _Traits, _Alloc >.

🎀 Classes 🎀

class sentry — Performs setup work for input streams. literally the little pre-show helper for input streams 🫶

🦋 Public Types 🦋

typedef ctype< _CharT > __ctype_type
typedef basic_ios< _CharT, _Traits > __ios_type
typedef basic_istream< _CharT, _Traits > __istream_type
typedef num_get< _CharT, istreambuf_iterator< _CharT, _Traits > > __num_get_type
typedef basic_streambuf< _CharT, _Traits > __streambuf_type
typedef _CharT char_type
enum event { erase_event, imbue_event, copyfmt_event } — The set of events that may be passed to an event callback. event girlies, this is your list 💫
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
typedef num_put< _CharT, ostreambuf_iterator< _CharT, _Traits > > __num_put_type

👑 Public Member Functions 👑

basic_istream (__streambuf_type *__sb) — Base constructor. the classic "gimme a streambuf and let's go" move 💅
virtual ~basic_istream () — Base destructor.
template<typename _ValueT > basic_istream< _CharT, _Traits > & _M_extract (_ValueT &__v) — the extract helper signature, exactly as the page says it.
const locale & _M_getloc () const — Locale access.
void _M_setstate (iostate __state) — state-setting helper signature, no extra description attached on this page.
bool bad () const — Fast error checking. is the stream in a bad-bad mood? 😭
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. specifically the end-of-file check, bestie.
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.
streamsize gcount () const — Character counting.
basic_istream< char > & getline (char_type *__s, streamsize __n, char_type __delim) — Explicit specialization declarations, defined in src/istream.cc.
basic_istream< wchar_t > & getline (char_type *__s, streamsize __n, char_type __delim) — the wchar_t specialization declaration.
locale getloc () const — Locale access.
bool good () const — Fast error checking. the "everything's chill" check ✨
basic_istream< char > & ignore (streamsize __n) — the char specialization declaration for ignoring input.
basic_istream< wchar_t > & ignore (streamsize __n) — the wchar_t specialization declaration for ignoring input.
basic_istream< char > & ignore (streamsize __n, int_type __delim) — the char specialization declaration with a delimiter.
basic_istream< wchar_t > & ignore (streamsize __n, int_type __delim) — the wchar_t specialization declaration with a delimiter.
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.
__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.
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.
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.

⚠️ bestie, that exception note is important: badbit gets set, but that does not mean an ios_base::failure gets thrown there. the original exception comes back if badbit is set in the exceptions mask. no cap.

__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.
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.
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 ✨

Okay bestie, these are the shared, class-wide constants of <ios_base> — every single one of them is static const, so nobody in the group chat gets to edit them. Periodt. 💅

static const openmode __noreplace — literally no blurb in the docs for this one, she's mysterious, we move 🎀
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. 🦋 the vibe check passed, we love to see it
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 } — that's the whole thing. No description, no notes, just vibes and an internal word-size constant. 🌸

💜 Protected Member Functions 💜

basic_istream (basic_istream &&__rhs)
basic_istream (const basic_istream &)=delete) — nope, copying is deleted, do not attempt 🚫
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 ()
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. that's it, that's the whole job description ✨
void move (basic_ios &&__rhs)
void move (basic_ios &__rhs)
basic_istream & operator= (basic_istream &&__rhs)
basic_istream & operator= (const basic_istream &)=delete — again: copy assignment is deleted, bestie. it's giving "we are NOT doing that" 💀
void set_rdbuf (basic_streambuf< _CharT, _Traits > *__sb)
void swap (basic_ios &__rhs) noexcept
void swap (basic_istream &__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

🫶 Friends 🫶

class sentry — our one and only friend. iconic. 👑

💖 Detailed Description 💖

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

Template Parameters

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

So like, this is the base class for all input streams, no cap. It provides text formatting of all builtin types, and it communicates with any class derived from basic_streambuf to do the actual input. She's the main character, the rest are supporting cast. 🎀

🦋 Member Typedef Documentation 🦋

`__num_put_type`

template<typename _CharT , typename _Traits > typedef num_put<_CharT,
    ostreambuf_iterator<_CharT, _Traits> > std::basic_ios< _CharT, _Traits
    >::__num_put_type [inherited]

These are non-standard types. (iykyk — they're libstdc++'s own little house specials 🍓)

`event_callback`

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

The type of an event callback function. 📞

Parameters

__e — one of the members of the event enum.
__b — reference to the ios_base object.
__i — the integer provided when the callback was registered.

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

`fmtflags`

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

This is a bitmask type. _Ios_Fmtflags is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type fmtflags are:

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

`iostate`

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

This is a bitmask type. _Ios_Iostate is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type iostate are:

badbit
eofbit
failbit
goodbit

`openmode`

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

This is a bitmask type. _Ios_Openmode is implementation-defined, but it is valid to perform bitwise operations on these values and expect the Right Thing to happen. Defined objects of type openmode are:

app
ate
binary
in
out
trunc

`seekdir`

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

This is an enumerated type. _Ios_Seekdir is implementation-defined. 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 ⭐

`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().

🌸 Constructor & Destructor Documentation 🌸

`basic_istream`

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

Base constructor. This ctor is almost never called by the user directly — rather from derived classes' initialization lists, which pass a pointer to their own stream buffer.

References std::basic_ios< _CharT, _Traits >::init().

`~basic_istream`

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

Base destructor. This does very little apart from providing a virtual base dtor. lowkey she's just here to exist 😌

References std::basic_istream< _CharT, _Traits >::_M_gcount.

💅 Member Function Documentation 💅

`_M_getloc`

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

Locale access.

Returns

A reference to the current locale.

Like getloc above, but returns a reference instead of generating a copy. 🎀

Referenced by std::money_get< _CharT, _InIter >::do_get(), std::time_get< _CharT, _InIter >::do_get(), std::num_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().

`bad`

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

Fast error checking. ⚡

Returns

True if the badbit is set.

Careful bestie: note that other iostate flags may also be set. So don't go reading this as "only badbit, nothing else."

References std::ios_base::badbit, and std::basic_ios< _CharT, _Traits >::rdstate().

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

`clear`

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

[Re]sets the error state. 🔄

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.

Okay bestie, before we move on, this lil’ function is living rent-free in a bunch of other functions’ heads — it’s giving main character energy. Here’s the full name-drop squad (yes, duplicates and all, we don’t edit the guest list):

std::basic_ios< _CharT, _Traits >::exceptions()
std::basic_ifstream< _CharT, _Traits >::open()
std::basic_fstream< _CharT, _Traits >::open()
std::basic_ofstream< _CharT, _Traits >::open()
std::basic_ifstream< _CharT, _Traits >::open()
std::basic_fstream< _CharT, _Traits >::open()
std::basic_ofstream< _CharT, _Traits >::open()
std::__detail::operator>>()
std::basic_istream< _CharT, _Traits >::putback()
std::basic_istream< _CharT, _Traits >::seekg()
std::basic_istream< _CharT, _Traits >::seekg()
std::basic_ios< _CharT, _Traits >::setstate()
std::basic_istream< _CharT, _Traits >::unget()

💅 `basic_ios::copyfmt`

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

Copies fields of __rhs into this. It’s literally the “copy their whole vibe” function, no cap.

Parameters:

__rhs — The source values for the copies.

Returns: Reference to this object.

All fields of __rhs are copied into this object except that rdbuf() and rdstate() remain unchanged. All values in the pword and iword arrays are copied. Before copying, each callback is invoked with erase_event. After copying, each (new) callback is invoked with copyfmt_event. The final step is to copy exceptions().

References:

std::__addressof()
std::basic_ios< _CharT, _Traits >::exceptions()
std::basic_ios< _CharT, _Traits >::fill()
std::ios_base::flags()
std::ios_base::getloc()
std::ios_base::precision()
std::basic_ios< _CharT, _Traits >::tie()
std::tie()
std::ios_base::width()

🦋 `basic_ios::eof`

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

Fast error checking. It’s giving “are we at the end?” energy.

Returns: True if the eofbit is set.

Note that other iostate flags may also be set. So don’t assume it’s only EOF, bestie.

References:

std::ios_base::eofbit
std::basic_ios< _CharT, _Traits >::rdstate()

✨ `basic_ios::exceptions` (const version)

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

Throwing exceptions on errors. This one just peeks at the mask, it doesn’t touch anything.

Returns: The current exceptions mask.

This changes nothing in the stream. See the one-argument version of exceptions(iostate) for the meaning of the return value.

Referenced by:

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

🎀 `basic_ios::exceptions` (mask-setting version)

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

Throwing exceptions on errors. This is the one where you actually set the mask.

Parameters:

__except — The new exceptions mask.

By default, error flags are set silently. 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.

If the error flag is already set when the exceptions mask is added, the exception is immediately thrown. 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);
}

References:

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

💀 `basic_ios::fail`

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

Fast error checking. This is the “did something go wrong?” vibe check.

Returns: True if either the badbit or the failbit is set.

Checking the badbit in fail() is historical practice. Note that other iostate flags may also be set.

References:

std::ios_base::badbit
std::ios_base::failbit
std::basic_ios< _CharT, _Traits >::rdstate()

Referenced by:

std::basic_ios< _CharT, _Traits >::operator bool()
std::basic_ios< _CharT, _Traits >::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()
std::basic_ostream< _CharT, _Traits >::tellp()
std::regex_traits< _Ch_type >::value()

🌸 `basic_ios::fill` (const)

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

Retrieves the empty character. The “what are we padding with?” queen.

Returns: The current fill character.

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

References:

std::basic_ios< _CharT, _Traits >::widen()

Referenced by:

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

🧚 `basic_ios::fill` (setter)

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

Sets a new empty character. Changing the padding vibe, iconic.

Parameters:

__ch — The new character.

Returns: The previous fill character.

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.

References:

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

⭐ `ios_base::flags` (getter)

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

Access to format flags. Peeking at the format control settings, no biggie.

Returns: The format control flags for both input and output.

Referenced by (a whole crowd):

std::basic_istream< _CharT, _Traits >::sentry::sentry()
std::basic_ostream< _CharT, _Traits >::sentry::~sentry()
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::normal_distribution< double >::operator()()
std::operator<<()
std::chrono::operator<<()
std::operator>>()
std::operator>>()
std::__detail::operator>>()
std::operator>>()
std::operator>>()
std::operator>>()
std::operator>>()
std::operator>>()
std::operator>>()

🔥 `ios_base::flags` (setter)

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

Setting new format flags all at once. It’s a full glow-up for the flags.

Parameters:

__fmtfl — The new flags to set.

Returns: The previous format control flags.

This function overwrites all the format flags with __fmtfl. No merge, just replace, periodt.

👑 `basic_istream::gcount`

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

Character counting. It’s literally counting how many characters got extracted last time.

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

References:

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

🍓 `basic_istream::get` (no args)

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

Simple extraction. Grabbing one character, lowkey.

Returns: A character, or eof().

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

References:

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

Referenced by:

std::basic_istream< _CharT, _Traits >::get()
std::basic_istream< _CharT, _Traits >::get()

🦋 `basic_istream::get` (streambuf)

template<typename _CharT , typename _Traits > __istream_type &
std::basic_istream< _CharT, _Traits >::get (__streambuf_type & __sb) [inline]

Extraction into another streambuf. Sending the characters to a different spot.

Parameters:

__sb — A streambuf in which to store data.

Returns: *this

Returns get(__sb,widen('\n')).

References:

std::basic_istream< _CharT, _Traits >::get()
std::basic_ios< _CharT, _Traits >::widen()

💜 `basic_istream::get` (streambuf + delim)

template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits
> & std::basic_istream< _CharT, _Traits >::get (__streambuf_type & __sb,
char_type __delim)

Extraction into another streambuf. Same energy, but now with a stop character.

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:

std::basic_istream< _CharT, _Traits >::_M_gcount
std::ios_base::goodbit

🌈 `basic_istream::get` (char ref)

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

Simple extraction. One character, stored right into __c.

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.

References:

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

🎀 `basic_istream::get` (char array)

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

Simple multiple-character extraction. It’s the group-chat version of get — more than one character at a time.

Parameters:

__s — Pointer to an array.
__n — Maximum number of characters to store in s.

Returns: *this

Returns get(__s,__n,widen('\n')).

References:

std::basic_istream< _CharT, _Traits >::get()
std::basic_ios< _CharT, _Traits >::widen()

💖 `basic_istream::get` (char array + delim)

template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits
> & std::basic_istream< _CharT, _Traits >::get (char_type * __s,
streamsize __n, char_type __delim)

Simple multiple-character extraction. Same array vibe, but you get to pick the stop character.

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.

References:

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

💖 `getline` — string extraction (the short one)

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

okay so this one is the cutie little two-arg version of string extraction ✨

Parameters
- __s — a character array in which to store the data 🫶
- __n — maximum number of characters to extract
Returns — *this

Literally just returns getline(__s,__n,widen('\n')). That's the whole vibe, no cap 💅

References std::basic_istream< _CharT, _Traits >::getline(), and std::basic_ios< _CharT, _Traits >::widen().

🎀 `getline` — string extraction (the full version, with the delimiter)

template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits
    > & std::basic_istream< _CharT, _Traits >::getline (char_type * __s,
    streamsize __n, char_type __delim)

Parameters
- __s — a character array in which to store the data 🌸
- __n — maximum number of characters to extract
- __delim — a 'stop' character
Returns — *this

So it extracts and stores characters into __s until one of these things happens. And bestie, listen — these criteria are required to be tested in the order listed here, specifically so that an input line can exactly fill the __s array without setting failbit. Order matters, iykyk 👑

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 — love that for us fr fr.)

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

Referenced by std::basic_istream< _CharT, _Traits >::getline().

🦋 `getline` — the `char` specialization

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

Explicit specialization declarations, defined in src/istream.cc. that's it that's the whole thing 💀

🧚 `getloc` — locale access

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

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. iconic behaviour honestly.

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

⭐ `good` — fast error checking

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

Returns — True if no error flags are set ✅

It's a wrapper around rdstate. simple, clean, no drama.

References std::basic_ios< _CharT, _Traits >::rdstate().

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

💅 `ignore` — simple extraction (no args)

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

Returns — a character, or eof()

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

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

🌈 `ignore` — simple extraction (with a count)

template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits
    > & std::basic_istream< _CharT, _Traits >::ignore (streamsize __n)

Returns — a character, or eof()

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

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

🔥 `ignore` — discarding characters (count + delimiter)

template<typename _CharT , typename _Traits > basic_istream< _CharT, _Traits
    > & std::basic_istream< _CharT, _Traits >::ignore (streamsize __n,
    int_type __delim)

Parameters
- __n — number of characters to discard
- __delim — a 'stop' character
Returns — *this

Extracts characters and throws them away (bye bestie 👋) 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 three 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. slay 💅

🌸 `imbue` — moving to a new locale

template<typename _CharT , typename _Traits > locale std::basic_ios< _CharT,
    _Traits >::imbue (const locale & __loc) [inherited]

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 http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html 🦋

References std::ios_base::imbue().

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

👑 `init` — all the setup, performed here

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

All setup is performed here. This is called from the public constructor. It is not virtual and cannot be redefined. no notes, main character energy only ✨

Referenced by — okay this list is lowkey a lot, but we keep every single one, no skipping:

std::basic_fstream< _CharT, _Traits >::basic_fstream()
std::basic_fstream< _CharT, _Traits >::basic_fstream()
std::basic_fstream< _CharT, _Traits >::basic_fstream()
std::basic_ifstream< _CharT, _Traits >::basic_ifstream()
std::basic_ifstream< _CharT, _Traits >::basic_ifstream()
std::basic_ifstream< _CharT, _Traits >::basic_ifstream()
std::basic_ios< _CharT, _Traits >::basic_ios()
std::basic_istream< _CharT, _Traits >::basic_istream()
std::basic_istringstream< _CharT, _Traits, _Alloc >::basic_istringstream()
std::basic_istringstream< _CharT, _Traits, _Alloc >::basic_istringstream()
std::basic_istringstream< _CharT, _Traits, _Alloc >::basic_istringstream()
std::basic_ofstream< _CharT, _Traits >::basic_ofstream()
std::basic_ofstream< _CharT, _Traits >::basic_ofstream()
std::basic_ofstream< _CharT, _Traits >::basic_ofstream()
std::basic_ostream< _CharT, _Traits >::basic_ostream()
std::basic_ostringstream< _CharT, _Traits, _Alloc >::basic_ostringstream()
std::basic_ostringstream< _CharT, _Traits, _Alloc >::basic_ostringstream()
std::basic_ostringstream< _CharT, _Traits, _Alloc >::basic_ostringstream()
std::basic_stringstream< _CharT, _Traits, _Alloc >::basic_stringstream()
std::basic_stringstream< _CharT, _Traits, _Alloc >::basic_stringstream()
std::basic_stringstream< _CharT, _Traits, _Alloc >::basic_stringstream()

(yes the repeats are real, that's literally how it's listed 💀)

🍓 `iword` — access to integer array

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

Parameters
- __ix — index into the array
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 get attached, she moves 💀

🧚 `narrow` — squeezes characters

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

Parameters
- __c — the character to narrow
- __dfault — the character to narrow
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 http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html 🌈

💜 `operator bool` — the quick-and-easy status check

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

The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... — genuinely so convenient, obsessed ✨

References std::basic_ios< _CharT, _Traits >::fail().

🎀 `operator!` — the other quick-and-easy status check

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

The quick-and-easy status check. This allows you to write constructs such as if (!a_stream) ... and while (a_stream) ... 🫶

References std::basic_ios< _CharT, _Traits >::fail().

⭐ `operator>>` — interface for manipulators (the `__ios_type` one)

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

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>>` — interface for manipulators (the `__istream_type` one)

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

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>>` — extracting into another streambuf

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

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 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>>` — integer arithmetic extractors (`bool`)

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

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. that's the whole tea, bestie 🍵✨

🍓 `operator>>(double& __f)`

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

Floating point arithmetic extractors, bestie 💖

Parameters — __f: a variable of builtin floating point type.
Returns — *this if successful.

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

🌸 `operator>>(float& __f)`

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

Floating point arithmetic extractors 💅

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& __n)`

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

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. no cap.

🦋 `operator>>(ios_base& (*__pf)(ios_base&))`

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

Interface for manipulators, periodt ✨ 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& __n)`

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

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>>(long double& __f)`

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

Floating point arithmetic extractors 💖

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. literally the same slay as before but bigger 💅

⭐ `operator>>(long long& __n)`

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

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>>(short& __n)`

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

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.

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

okay this one's got the extra bit set energy — badbit, failbit, goodbit, all of it 💀

🌺 `operator>>(unsigned int& __n)`

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

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& __n)`

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

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& __n)`

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

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 short& __n)`

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

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*& __p)`

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

Basic arithmetic extractors 🌟

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()`

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

Looking ahead in the stream 👀 no touching, just vibes.

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. Like window shopping for characters, bestie 🛍️

References: std::basic_istream< _CharT, _Traits >::_M_gcount.

📏 `std::ios_base::precision() const`

streamsize std::ios_base::precision () const [inline],  [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. (the standard committee said "not today" 😭)

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

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

streamsize std::ios_base::precision (streamsize __prec) [inline],
    [inherited]

Changing flags 💅

Parameters — __prec: the new precision value.
Returns — the previous value of precision().

it's giving "here's your old one back, thanks for the trade" 🫶

↩️ `putback(char_type __c)`

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

Unextracting a single character 😭 yes, "unextracting" is a real word here, we love a glow-up in reverse.

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.

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

References: std::basic_istream< _CharT, _Traits >::_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<<().

🫧 `std::ios_base::pword(int __ix)`

void *& std::ios_base::pword (int __ix) [inline],  [inherited]

Access to void pointer array 🎯

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. 💀 like holding a balloon that might get relocated mid-party.

🧺 `rdbuf() const`

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

Accessing the underlying buffer 💖

Returns — the current stream buffer.

This does not change the state of the stream. zero drama, just peek at the buffer 👑

Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::~sentry(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< char >::get(), std::basic_istream< _CharT, _Traits >::get(), std::getline(), std::getline(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits >::ignore(), std::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::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< char >::readsome(), 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(), and std::ws().

like, literally everyone wants a piece of this function 😭 main character energy fr.

🔄 `rdbuf(basic_streambuf<_CharT, _Traits>* __sb)`

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.

Associates a new buffer with the current stream, and clears the error state.

💀 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.

For example:

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

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

"hysterical raisins" lives in my head rent free 🍇😭

🚦 `rdstate() const`

template<typename _CharT , typename _Traits > iostate std::basic_ios<
    _CharT, _Traits >::rdstate () const [inline],  [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(). slay.

Referenced by std::basic_ios< _CharT, _Traits >::bad(), std::basic_ios< _CharT, _Traits >::eof(), std::basic_ios< _CharT, _Traits >::fail(), std::basic_ios< _CharT, _Traits >::good(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ios< _CharT, _Traits >::setstate(), and std::basic_istream< _CharT, _Traits >::unget(). That’s the whole little guest list, bestie 💅.

`read` — extraction without delimiters ✨

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

Okay so this one is extraction without delimiters, no cap. 🎀

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 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: std::basic_istream< _CharT, _Traits >::_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` — extraction until the buffer is exhausted, but no more 🦋

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

Parameters

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

Returns

The number of characters extracted.

It extracts characters and stores them into __s depending on how many characters are 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. Main character buffer energy, honestly. ✨

References: std::basic_istream< _CharT, _Traits >::_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` — add the callback `fn` with parameter `index` 🎀

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

(inherited)

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. Order matters, bestie — the callbacks are literally queued in registration order. 💅

`seekg` — changing the current read position 🌸

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

Parameters

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

Returns

*this

If fail() is not true, calls rdbuf()->pubseekoff(__off,__dir). If that function fails, 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` — changing the current read position, position-object edition 🦋

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

Parameters

__pos — a file position object.

Returns

*this

If fail() is not true, calls rdbuf()->pubseekpos(__pos). If that function fails, 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(). 🫶

`setf` — setting new format flags 🌈

fmtflags std::ios_base::setf (fmtflags __fmtfl)

(inline, inherited)

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. Stack ’em, don’t replace ’em, basically. ✨

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

`setf` — setting new format flags with a mask 💅

fmtflags std::ios_base::setf (fmtflags __fmtfl, fmtflags __mask)

(inline, inherited)

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. Mask on, flags set, previous flags returned — she’s organized. 🎀

`setstate` — sets additional flags in the error state 🔥

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

(inline, inherited)

Parameters

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

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

References: std::basic_ios< _CharT, _Traits >::clear(), and std::basic_ios< _CharT, _Traits >::rdstate().

Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::~sentry(), std::basic_ifstream< _CharT, _Traits >::close(), std::basic_ofstream< _CharT, _Traits >::close(), std::basic_fstream< _CharT, _Traits >::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_ifstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::operator<<(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::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(), and std::ws().

That is a whole crowd of references, bestie — she’s popular. 👑

`sync` — synchronizing the stream buffer ⭐

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

Returns

0 on success, -1 on failure.

If rdbuf() is a null pointer, returns -1.

Otherwise, calls rdbuf()->pubsync(), and if that returns -1, sets badbit and returns -1.

Otherwise, returns 0.

Note: this function 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::ios_base::goodbit, std::basic_streambuf< _CharT, _Traits >::pubsync(), std::basic_ios< _CharT, _Traits >::rdbuf(), and std::basic_ios< _CharT, _Traits >::setstate().

`sync_with_stdio` — interaction with the standard C I/O objects 🍓

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

(static, inherited)

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.

Only the standard ones, okay? Your own little streams are living their own lives. 🦋

`tellg` — getting the current read position 🎀

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

Returns

A file position object.

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

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().

`tie` — fetches the current tied stream 🌸

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

(inline, inherited)

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 “flush your bestie before you read” energy. 💅

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

`tie` — ties this stream to an output stream 🫶

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

(inline, inherited)

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. New tie, who dis — but it still hands back the old one. ✨

`unget` — unextracting the previous character 💜

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

Returns

*this

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

If rdbuf() is null or if sungetc() fails, sets badbit in the error state. Put it back or catch these bad vibes, bestie. 😭

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: std::basic_istream< _CharT, _Traits >::_M_gcount, std::basic_ios< _CharT, _Traits >::clear(), std::ios_base::eofbit, std::ios_base::goodbit, and std::basic_ios< _CharT, _Traits >::rdstate().

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

💖 Member Data Documentation 💖

Okay bestie, this is the data-member section, and yes, it's giving "long but important." Every declaration, every reference list, every little inherited flag — all here, no skips. 🫶

template<typename _CharT , typename _Traits > streamsize std::basic_istream< _CharT, _Traits >::_M_gcount [protected] — the number of characters extracted in the previous unformatted function; see gcount().
- Referenced by: std::basic_istream< _CharT, _Traits >::~basic_istream(), std::basic_istream< _CharT, _Traits >::gcount(), 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::basic_istream< char >::get(), std::basic_istream< char >::ignore(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< char >::operator>>(), std::basic_istream< _CharT, _Traits >::peek(), std::basic_istream< _CharT, _Traits >::putback(), std::basic_istream< char >::putback(), std::basic_istream< _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream< char >::readsome(), std::basic_istream< char >::sync(), and std::basic_istream< _CharT, _Traits >::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< _CharT, _Traits >::_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 >::bad(), std::basic_ios< _CharT, _Traits >::fail(), std::basic_ostream< _CharT, _Traits >::flush(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< char >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_ostream< _CharT, _Traits >::operator<<(), std::operator>>(), std::basic_istream< _CharT, _Traits >::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< char >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::sync(), std::basic_istream< char >::tellg(), std::basic_istream< _CharT, _Traits >::tellg(), 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.
- 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.
- Referenced by: 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.
- Referenced by: std::dec().
const seekdir std::ios_base::end [static], [inherited] — request a seek relative to the current end of the sequence.
- 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.
- Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::time_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::num_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_ios< _CharT, _Traits >::eof(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< char >::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, _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< char >::sync(), std::basic_istream< _CharT, _Traits >::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.
- Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::basic_ostream< _CharT, _Traits >::sentry::sentry(), std::basic_ifstream< _CharT, _Traits >::close(), std::basic_ofstream< _CharT, _Traits >::close(), std::basic_fstream< _CharT, _Traits >::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_ios< _CharT, _Traits >::fail(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< char >::get(), std::time_get< _CharT, _InIter >::get(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_fstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::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.
- 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.
- Referenced by: std::defaultfloat(), std::fixed(), std::hexfloat(), and std::scientific().
const iostate std::ios_base::goodbit [static], [inherited] — the “everything is literally fine” state: Indicates all is well. 💖

Referenced by: std::basic_istream< _CharT, _Traits >::sentry::sentry(), std::time_get< _CharT, _InIter >::do_get(), 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_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< char >::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_ostream< _CharT, _Traits >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(), std::basic_istream< _CharT, _Traits >::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< char >::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] — hexadecimal era: Converts integer input or generates integer output in hexadecimal base. 🧮

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. 🚪

Referenced by: std::basic_filebuf< _CharT, _Traits >::_M_set_buffer(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_ifstream< _CharT, _Traits >::open(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_filebuf< _CharT, _Traits >::pbackfail(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_istream< _CharT, _Traits >::seekg(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits >::showmanyc(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::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] — the “put the fill in the middle” option: Adds fill characters at a designated internal point in certain generated output, or identical to right if no such point is designated. 🎯

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.) ⬅️✨

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

const fmtflags std::ios_base::oct [static], [inherited] — octal moment: Converts integer input or generates integer output in octal base. 🐙

Referenced by: std::oct().

const openmode std::ios_base::out [static], [inherited] — open for output. Default for ofstream and fstream. 📤

Referenced by: std::basic_filebuf< _CharT, _Traits >::_M_set_buffer(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_ofstream< _CharT, _Traits >::open(), std::basic_filebuf< _CharT, _Traits >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::overflow(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::pbackfail(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_stringbuf< _CharT, _Traits, _Alloc >::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.) ➡️💅

Referenced by: std::right().

const fmtflags std::ios_base::scientific [static], [inherited] — science-y float energy: Generates floating-point output in scientific notation. 🔬

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. 🏷️

Referenced by: std::num_put< _CharT, _OutIter >::do_put(), std::noshowbase(), and std::showbase().

const fmtflags std::ios_base::showpoint [static], [inherited] — Generates a decimal-point character unconditionally in generated floating-point output. 💧

Referenced by: std::noshowpoint(), and std::showpoint().

const fmtflags std::ios_base::showpos [static], [inherited] — Generates a + sign in non-negative generated numeric output. ➕

Referenced by: std::noshowpos(), and std::showpos().

const fmtflags std::ios_base::skipws [static], [inherited] — Skips leading white space before certain input operations. 🫧

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

const openmode std::ios_base::trunc [static], [inherited] — Truncate an existing stream when opening. Default for ofstream. ✂️ No Referenced by list on this one.
const fmtflags std::ios_base::unitbuf [static], [inherited] — Flushes output after each output operation. 🚽✨

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. 🔠

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. 💅

Source/version tea ☕: this page says it was generated automatically by Doxygen for libstdc++ from the source code, and the footer tag is libstdstd::basic_ist...harT, _Traits >(3cxx). Date slot: not printed here, so no invented date — periodt. 🎀✨

📦 where this page comes from

ubuntu noble: libstdc++-14-doc 14-20240412-0ubuntu1
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

STD::BASIC_ISTREAM(3cxx)

🌈 std::basic_istream< _CharT, _Traits > 🌈

💖 NAME 💖

🌸 SYNOPSIS 🌸

🎀 Classes 🎀

🦋 Public Types 🦋

👑 Public Member Functions 👑

🔥 Extractors 🔥

🌊 Unformatted Input Functions 🌊

🌟 Static Public Member Functions 🌟

✨ Static Public Attributes ✨

🧚 Protected Types 🧚

💜 Protected Member Functions 💜

🌈 Protected Attributes 🌈

🫶 Friends 🫶

💖 Detailed Description 💖

Template Parameters

🦋 Member Typedef Documentation 🦋

__num_put_type

event_callback

fmtflags

iostate

openmode

seekdir

⭐ Member Enumeration Documentation ⭐

enum std::ios_base::event [inherited]

🌸 Constructor & Destructor Documentation 🌸

basic_istream

~basic_istream

💅 Member Function Documentation 💅

_M_getloc

bad

clear

💅 basic_ios::copyfmt

🦋 basic_ios::eof

✨ basic_ios::exceptions (const version)

🎀 basic_ios::exceptions (mask-setting version)

💀 basic_ios::fail

🌸 basic_ios::fill (const)

🧚 basic_ios::fill (setter)

⭐ ios_base::flags (getter)

🔥 ios_base::flags (setter)

👑 basic_istream::gcount

🍓 basic_istream::get (no args)

🦋 basic_istream::get (streambuf)

💜 basic_istream::get (streambuf + delim)

🌈 basic_istream::get (char ref)

🎀 basic_istream::get (char array)

💖 basic_istream::get (char array + delim)

💖 getline — string extraction (the short one)

🎀 getline — string extraction (the full version, with the delimiter)

🦋 getline — the char specialization

🧚 getloc — locale access

⭐ good — fast error checking

💅 ignore — simple extraction (no args)

🌈 ignore — simple extraction (with a count)

🔥 ignore — discarding characters (count + delimiter)

🌸 imbue — moving to a new locale

👑 init — all the setup, performed here

🍓 iword — access to integer array

🧚 narrow — squeezes characters

💜 operator bool — the quick-and-easy status check

🎀 operator! — the other quick-and-easy status check

⭐ operator>> — interface for manipulators (the __ios_type one)

🦋 operator>> — interface for manipulators (the __istream_type one)

🔥 operator>> — extracting into another streambuf

👑 operator>> — integer arithmetic extractors (bool)

🍓 operator>>(double& __f)

🌸 operator>>(float& __f)

🎀 operator>>(int& __n)

🦋 operator>>(ios_base& (*__pf)(ios_base&))

💜 operator>>(long& __n)

🌈 operator>>(long double& __f)

⭐ operator>>(long long& __n)

🧚 operator>>(short& __n)

🌺 operator>>(unsigned int& __n)

🍓 operator>>(unsigned long& __n)

🎀 operator>>(unsigned long long& __n)

🦋 operator>>(unsigned short& __n)

👑 operator>>(void*& __p)

`__num_put_type`

`event_callback`

`fmtflags`

`iostate`

`openmode`

`seekdir`

`enum std::ios_base::event` [inherited]

`basic_istream`

`~basic_istream`

`_M_getloc`

`bad`

`clear`

💅 `basic_ios::copyfmt`

🦋 `basic_ios::eof`

✨ `basic_ios::exceptions` (const version)

🎀 `basic_ios::exceptions` (mask-setting version)

💀 `basic_ios::fail`

🌸 `basic_ios::fill` (const)

🧚 `basic_ios::fill` (setter)

⭐ `ios_base::flags` (getter)

🔥 `ios_base::flags` (setter)

👑 `basic_istream::gcount`

🍓 `basic_istream::get` (no args)

🦋 `basic_istream::get` (streambuf)

💜 `basic_istream::get` (streambuf + delim)

🌈 `basic_istream::get` (char ref)

🎀 `basic_istream::get` (char array)

💖 `basic_istream::get` (char array + delim)

💖 `getline` — string extraction (the short one)

🎀 `getline` — string extraction (the full version, with the delimiter)

🦋 `getline` — the `char` specialization

🧚 `getloc` — locale access

⭐ `good` — fast error checking

💅 `ignore` — simple extraction (no args)

🌈 `ignore` — simple extraction (with a count)

🔥 `ignore` — discarding characters (count + delimiter)

🌸 `imbue` — moving to a new locale

👑 `init` — all the setup, performed here

🍓 `iword` — access to integer array

🧚 `narrow` — squeezes characters

💜 `operator bool` — the quick-and-easy status check

🎀 `operator!` — the other quick-and-easy status check

⭐ `operator>>` — interface for manipulators (the `__ios_type` one)

🦋 `operator>>` — interface for manipulators (the `__istream_type` one)

🔥 `operator>>` — extracting into another streambuf

👑 `operator>>` — integer arithmetic extractors (`bool`)

🍓 `operator>>(double& __f)`

🌸 `operator>>(float& __f)`

🎀 `operator>>(int& __n)`

🦋 `operator>>(ios_base& (*__pf)(ios_base&))`

💜 `operator>>(long& __n)`

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

⭐ `operator>>(long long& __n)`

🧚 `operator>>(short& __n)`

🌺 `operator>>(unsigned int& __n)`

🍓 `operator>>(unsigned long& __n)`

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

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

👑 `operator>>(void*& __p)`

🔍 `peek()`

📏 `std::ios_base::precision() const`

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

↩️ `putback(char_type __c)`

🫧 `std::ios_base::pword(int __ix)`

🧺 `rdbuf() const`

🔄 `rdbuf(basic_streambuf<_CharT, _Traits>* __sb)`

🚦 `rdstate() const`

`read` — extraction without delimiters ✨

`readsome` — extraction until the buffer is exhausted, but no more 🦋

`register_callback` — add the callback `fn` with parameter `index` 🎀

`seekg` — changing the current read position 🌸

`seekg` — changing the current read position, position-object edition 🦋

`setf` — setting new format flags 🌈

`setf` — setting new format flags with a mask 💅

`setstate` — sets additional flags in the error state 🔥

`sync` — synchronizing the stream buffer ⭐

`sync_with_stdio` — interaction with the standard C I/O objects 🍓

`tellg` — getting the current read position 🎀

`tie` — fetches the current tied stream 🌸

`tie` — ties this stream to an output stream 🫶