__GNU_CXX::STDIO_FILEBUF(3cxx)

📦
version 14-20240412 · 24 versions
, in ubuntu noble

💅 __gnu_cxx::stdio_filebuf< _CharT, _Traits > 💅

okay bestie, welcome to the 3cxx corner of the manual — this is the whole ✨vibe✨ of a GNU extension class that literally exists so C and C++ can hold hands and get along 🫶

🌸 NAME 🌸

__gnu_cxx::stdio_filebuf< _CharT, _Traits > — the icon that "Provides a layer of compatibility for C/POSIX." 💅 no cap, that's her whole job.

✨ SYNOPSIS ✨

#include <stdio_filebuf.h>

She Inherits std::basic_filebuf< _CharT, _Traits >. main character energy from birth, fr fr 👑

🦋 Public Types 🦋

  • typedef codecvt< char_type, char, __state_type > __codecvt_type
  • typedef __basic_file< char > __file_type
  • typedef basic_filebuf< char_type, traits_type > __filebuf_type
  • typedef traits_type::state_type __state_type
  • typedef basic_streambuf< char_type, traits_type > __streambuf_type
  • typedef _CharT char_type
  • typedef traits_type::int_type int_type
  • typedef traits_type::off_type off_type
  • typedef traits_type::pos_type pos_type
  • typedef std::size_t size_t
  • typedef _Traits traits_type

like, that's a whole wardrobe of typedefs and every single one ate 💖

💜 Public Member Functions 💜

  • stdio_filebuf ()
  • stdio_filebuf (int __fd, std::ios_base::openmode __mode, size_t __size=static_cast< size_t >(BUFSIZ))
  • stdio_filebuf (std::__c_file *__f, std::ios_base::openmode __mode, size_t __size=static_cast< size_t >(BUFSIZ))
  • stdio_filebuf (stdio_filebuf &&)=default
  • virtual ~stdio_filebuf ()
  • __filebuf_type * close () — Closes the currently associated file.
  • int fd ()
  • std::__c_file * file ()
  • locale getloc () const — Locale access.
  • streamsize in_avail () — Looking ahead into the stream.
  • bool is_open () const throw () — Returns true if the external file is open.
  • template<typename _Path > _If_fs_path< _Path, __filebuf_type * > open (const _Path &__s, ios_base::openmode __mode) — Opens an external file.
  • __filebuf_type * open (const char *__s, ios_base::openmode __mode) — Opens an external file.
  • __filebuf_type * open (const std::string &__s, ios_base::openmode __mode) — Opens an external file.
  • stdio_filebuf & operator= (stdio_filebuf &&)=default
  • locale pubimbue (const locale &__loc) — Entry point for imbue().
  • int_type sbumpc () — Getting the next character.
  • int_type sgetc () — Getting the next character.
  • streamsize sgetn (char_type *__s, streamsize __n) — Entry point for xsgetn.
  • int_type snextc () — Getting the next character.
  • int_type sputbackc (char_type __c) — Pushing characters back into the input stream.
  • int_type sputc (char_type __c) — Entry point for all single-character output functions.
  • streamsize sputn (const char_type *__s, streamsize __n) — Entry point for all single-character output functions.
  • int_type sungetc () — Moving backwards in the input stream.
  • void swap (basic_filebuf &)
  • void swap (stdio_filebuf &__fb)
  • basic_streambuf * pubsetbuf (char_type *__s, streamsize __n) — Entry points for derived buffer functions.
  • pos_type pubseekoff (off_type __off, ios_base::seekdir __way, ios_base::openmode __mode=ios_base::in|ios_base::out) — Alters the stream position.
  • pos_type pubseekpos (pos_type __sp, ios_base::openmode __mode=ios_base::in|ios_base::out) — Alters the stream position.
  • int pubsync () — Calls virtual sync function.

🎀 Protected Member Functions 🎀

  • void __safe_gbump (streamsize __n)
  • void __safe_pbump (streamsize __n)
  • void _M_allocate_internal_buffer ()
  • bool _M_convert_to_external (char_type *, streamsize)
  • void _M_create_pback ()
  • void _M_destroy_internal_buffer () throw ()
  • void _M_destroy_pback () throw ()
  • int _M_get_ext_pos (__state_type &__state)
  • pos_type _M_seek (off_type __off, ios_base::seekdir __way, __state_type __state)
  • void _M_set_buffer (streamsize __off)
  • bool _M_terminate_output ()
  • void gbump (int __n) — Moving the read position.
  • virtual void imbue (const locale &__loc) — Changes translations.
  • virtual int_type overflow (int_type __c=_Traits::eof()) — Consumes data from the buffer; writes to the controlled sequence.
  • virtual int_type pbackfail (int_type __c=_Traits::eof()) — Tries to back up the input sequence.
  • void pbump (int __n) — Moving the write position.
  • virtual pos_type seekoff (off_type __off, ios_base::seekdir __way, ios_base::openmode __mode=ios_base::in|ios_base::out) — Alters the stream positions.
  • virtual pos_type seekpos (pos_type __pos, ios_base::openmode __mode=ios_base::in|ios_base::out) — Alters the stream positions.
  • virtual __streambuf_type * setbuf (char_type *__s, streamsize __n) — Manipulates the buffer.
  • void setg (char_type *__gbeg, char_type *__gnext, char_type *__gend) — Setting the three read area pointers.
  • void setp (char_type *__pbeg, char_type *__pend) — Setting the three write area pointers.
  • virtual streamsize showmanyc () — Investigating the data available.
  • void swap (basic_streambuf &__sb)
  • virtual int sync () — Synchronizes the buffer arrays with the controlled sequences.
  • virtual int_type uflow () — Fetches more data from the controlled sequence.
  • virtual int_type underflow () — Fetches more data from the controlled sequence.
  • virtual streamsize xsgetn (char_type *__s, streamsize __n) — Multiple character extraction.
  • virtual streamsize xsputn (const char_type *__s, streamsize __n) — Multiple character insertion.
  • char_type * eback () const — Access to the get area.
  • char_type * gptr () const — Access to the get area.
  • char_type * egptr () const — Access to the get area.
  • char_type * pbase () const — Access to the put area.
  • char_type * pptr () const — Access to the put area.
  • char_type * epptr () const — Access to the put area.

🌈 Protected Attributes 🌈

  • char_type * _M_buf — Pointer to the beginning of internal buffer.
  • bool _M_buf_allocated
  • locale _M_buf_locale — Current locale setting.
  • size_t _M_buf_size
  • const __codecvt_type * _M_codecvt
  • char * _M_ext_buf
  • streamsize _M_ext_buf_size
  • char * _M_ext_end
  • const char * _M_ext_next
  • __file_type _M_file
  • char_type * _M_in_beg — Start of get area.
  • char_type * _M_in_cur — Current read area.
  • char_type * _M_in_end — End of get area.
  • __c_lock _M_lock
  • ios_base::openmode _M_mode — Place to stash in || out || in | out settings for current filebuf.
  • char_type * _M_out_beg — Start of put area.
  • char_type * _M_out_cur — Current put area.
  • char_type * _M_out_end — End of put area.
  • bool _M_reading
  • __state_type _M_state_beg
  • __state_type _M_state_cur
  • __state_type _M_state_last
  • bool _M_writing
  • char_type _M_pback
  • char_type * _M_pback_cur_save
  • char_type * _M_pback_end_save
  • bool _M_pback_init

🔥 Detailed Description 🔥

template<typename _CharT, typename _Traits = std::char_traits<_CharT>>
    class __gnu_cxx::stdio_filebuf< _CharT, _Traits >

"Provides a layer of compatibility for C/POSIX.

This GNU extension provides extensions for working with standard C FILE*'s and POSIX file descriptors. It must be instantiated by the user with the type of character used in the file stream, e.g., stdio_filebuf<char>."

so like — bestie, you have to tell her what character type you're using. she's not gonna guess. stdio_filebuf<char> is the classic, but you do you 💅

🧚 Constructor & Destructor Documentation 🧚

template<typename _CharT , typename _Traits = std::char_traits<_CharT>> __gnu_cxx::stdio_filebuf< _CharT, _Traits >::stdio_filebuf () [inline]

deferred initialization ✨ (she's waiting, she's chill, she's not initialized yet)

template<typename _CharT , typename _Traits > __gnu_cxx::stdio_filebuf< _CharT, _Traits >::stdio_filebuf (int __fd, std::ios_base::openmode __mode, size_t __size = static_cast<size_t>( BUFSIZ ))

Parameters

  • __fd — An open file descriptor.
  • __mode — Same meaning as in a standard filebuf.
  • __size — Optimal or preferred size of internal buffer, in chars.

This constructor associates a file stream buffer with an open POSIX file descriptor. The file descriptor will be automatically closed when the stdio_filebuf is closed/destroyed. 👀 so like, she takes ownership. no take-backs.

template<typename _CharT , typename _Traits > __gnu_cxx::stdio_filebuf< _CharT, _Traits >::stdio_filebuf (std::__c_file * __f, std::ios_base::openmode __mode, size_t __size = static_cast<size_t>( BUFSIZ ))

Parameters

  • __f — An open FILE*.
  • __mode — Same meaning as in a standard filebuf.
  • __size — Optimal or preferred size of internal buffer, in chars. Defaults to system's BUFSIZ.

This constructor associates a file stream buffer with an open C FILE*. The FILE* will not be automatically closed when the stdio_filebuf is closed/destroyed. 🫶 she's just borrowing it, she's polite like that.

template<typename _CharT , typename _Traits > __gnu_cxx::stdio_filebuf< _CharT, _Traits >::~stdio_filebuf () [virtual]

Closes the external data stream if the file descriptor constructor was used. bye bestie 💀 (only if you used the __fd one, okay? remember the difference, it's giving very important)

fr fr the two constructors behave differently at destruction — one closes the thing, one does not. don't get it twisted 💅

⭐ Member Function Documentation ⭐

template<typename _CharT , typename _Traits > void std::basic_filebuf< _CharT, _Traits >::_M_create_pback () [inline], [protected], [inherited]

Initializes pback buffers, and moves normal buffers to safety.

Assumptions: _M_in_cur has already been moved back. 😌 she's trusting you on this one.

template<typename _CharT , typename _Traits > void std::basic_filebuf< _CharT, _Traits >::_M_destroy_pback () [inline], [protected], [inherited]

Deactivates pback buffer contents, and restores normal buffer.

Assumptions: The pback buffer has only moved forward. 🦋

template<typename _CharT , typename _Traits > void std::basic_filebuf< _CharT, _Traits >::_M_set_buffer (streamsize __off) [inline], [protected], [inherited]

This function sets the pointers of the internal buffer, both get and put areas. Typically:

  • __off == egptr() - eback() upon underflow/uflow (read mode);
  • __off == 0 upon overflow (write mode);
  • __off == -1 upon open, setbuf, seekoff/pos (uncommitted mode).
NB: epptr() - pbase() == _M_buf_size - 1, since _M_buf_size reflects the actual allocated memory and the last cell is reserved for the overflow char of a full put area. 🔥 lowkey the last cell is reserved, she's special, she has a job.

References std::ios_base::app, std::ios_base::in, and std::ios_base::out.

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

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits >::__filebuf_type * std::basic_filebuf< _CharT, _Traits >::close () [inherited]

Closes the currently associated file. 👋✨

Returns: this on success, NULL on failure.

If no file is currently open, this function immediately fails. (she's not doing a whole thing for nothing, bestie 😭)

If a put buffer area exists, overflow(eof) is called to flush all the characters. The file is then closed.

If any operations fail, this function also fails.

References std::basic_filebuf< _CharT, _Traits >::_M_mode, std::basic_filebuf< _CharT, _Traits >::_M_pback_init, std::basic_filebuf< _CharT, _Traits >::_M_reading, and std::basic_filebuf< _CharT, _Traits >::_M_set_buffer().

Referenced by std::basic_ifstream< _CharT, _Traits >::close(), std::basic_ofstream< _CharT, _Traits >::close(), and std::basic_fstream< _CharT, _Traits >::close(). like the whole friend group shows up to this one 🫶

🌸 eback() — where the get area starts

template<typename _CharT , typename _Traits > char_type *
    std::basic_streambuf< _CharT, _Traits >::eback () const

[inline], [protected], [inherited]

Okay so this is one of the get-area besties. 💅 Access to the get area, meaning these functions are only available to other protected functions, including derived classes. So like, it's a private little club — if you're not protected or derived, you're not getting in, sorry not sorry.

The trio, and yes you're gonna hear this again, deal with it:

  • eback() returns the beginning pointer for the input sequence
  • gptr() returns the next pointer for the input sequence
  • egptr() returns the end pointer for the input sequence

It references std::basic_streambuf< _CharT, _Traits >::_M_in_beg, which is the actual member holding that beginning pointer, iykyk.

It's referenced by std::basic_streambuf< _CharT, _Traits >::sputbackc(), and std::basic_streambuf< _CharT, _Traits >::sungetc() — the two functions that shove a character back onto the stream. Putting stuff back means knowing where the beginning is, so yeah, makes sense. 🎀

🦋 egptr() — where the get area ends

template<typename _CharT , typename _Traits > char_type *
    std::basic_streambuf< _CharT, _Traits >::egptr () const

[inline], [protected], [inherited]

The other end of the get-area trio, same rules: only other protected functions, including derived classes, get to call this. Not me, not you, not your cousin.

  • eback() returns the beginning pointer for the input sequence
  • gptr() returns the next pointer for the input sequence
  • egptr() returns the end pointer for the input sequence

References std::basic_streambuf< _CharT, _Traits >::_M_in_end — the member that actually stores the end pointer.

This one is busy, bestie. It's referenced by:

  • std::basic_streambuf< _CharT, _Traits >::in_avail()
  • std::basic_streambuf< _CharT, _Traits >::sbumpc()
  • std::basic_streambuf< _CharT, _Traits >::sgetc()
  • std::basic_stringbuf< _CharT, _Traits, _Alloc >::showmanyc()
  • std::wbuffer_convert< _Codecvt, _Elem, _Tr >::underflow()

Like, everyone wants to know where the buffer stops. Iconic behavior honestly. 👑

🎀 epptr() — where the put area ends

template<typename _CharT , typename _Traits > char_type *
    std::basic_streambuf< _CharT, _Traits >::epptr () const

[inline], [protected], [inherited]

Now we're on the put area, not the get area — different vibe, different trio. Same access rule though: only other protected functions, including derived classes.

  • pbase() returns the beginning pointer for the output sequence
  • pptr() returns the next pointer for the output sequence
  • epptr() returns the end pointer for the output sequence

Note the names — p for put, g for get. Yes it's that simple, yes it took me a minute too. 🙈

References std::basic_streambuf< _CharT, _Traits >::_M_out_end.

Referenced by exactly one function here: std::basic_streambuf< _CharT, _Traits >::sputc() — because to know if there's room for one more character you gotta know where the end is. Periodt.

💖 stdio_filebuf::fd() — the actual POSIX file descriptor

template<typename _CharT , typename _Traits  = std::char_traits<_CharT>> int
    __gnu_cxx::stdio_filebuf< _CharT, _Traits >::fd ()

[inline]

Returns: the underlying file descriptor.

Okay this one's the main character of the whole page honestly. Once associated with an external data stream, this function can be used to access the underlying POSIX file descriptor — like, the raw int the kernel gave you. 🫶

⚠️ But listen: there is no way for the library to track what you do with the descriptor, so be careful. That's it. That's the warning. It hands you the fd and dips, no supervision, no safety net. If you close it, re-read it, re-assign it — that's on you, bestie. 😭

💜 stdio_filebuf::file() — the actual FILE*

template<typename _CharT , typename _Traits  = std::char_traits<_CharT>>
    std::__c_file * __gnu_cxx::stdio_filebuf< _CharT, _Traits >::file ()

[inline]

Returns: the underlying FILE*.

Same energy as fd() but for the 'C' side — this function can be used to access the underlying 'C' file pointer. 🌈

⚠️ And same exact caveat: there is no way for the library to track what you do with the file, so be careful. The library is not your mom. It does not know what you did with that FILE*. Handle it responsibly. 💀

🍓 gbump(int __n) — nudge the read position forward

template<typename _CharT , typename _Traits > void std::basic_streambuf<
    _CharT, _Traits >::gbump (int __n)

[inline], [protected], [inherited]

Moving the read position. 📍

Parameters: __n — the delta by which to move.

This just advances the read position without returning any data. Like scrolling past messages in the group chat without replying — you moved, but nothing came back to you. Silent. Sneaky. Efficient.

References std::basic_streambuf< _CharT, _Traits >::_M_in_cur (the "next pointer", i.e. where you currently are).

Referenced by:

  • std::basic_streambuf< _CharT, _Traits >::sbumpc()
  • std::basic_streambuf< _CharT, _Traits >::sputbackc()
  • std::basic_streambuf< _CharT, _Traits >::sungetc()
  • std::basic_streambuf< _CharT, _Traits >::uflow()

🧚 getloc() — which locale are we in?

template<typename _CharT , typename _Traits > locale std::basic_streambuf<
    _CharT, _Traits >::getloc () const

[inline], [inherited]

Locale access. 💫

Returns: the current locale in effect.

So here's the tea: if pubimbue(loc) has been called, then the most recent loc is returned. Otherwise, the global locale in effect at the time of construction is returned. So it's either "the vibe you explicitly set" or "the vibe that was everywhere when this thing was born." ✨

References std::basic_streambuf< _CharT, _Traits >::_M_buf_locale.

Referenced by std::basic_streambuf< _CharT, _Traits >::pubimbue().

⭐ gptr() — where the get area is right now

template<typename _CharT , typename _Traits > char_type *
    std::basic_streambuf< _CharT, _Traits >::gptr () const

[inline], [protected], [inherited]

Back to the get area, and yes it's the same blurb, it's the same trio, I told you:

  • eback() returns the beginning pointer for the input sequence
  • gptr() returns the next pointer for the input sequence
  • egptr() returns the end pointer for the input sequence

Only other protected functions, including derived classes, can touch it. 🔒

References std::basic_streambuf< _CharT, _Traits >::_M_in_cur.

And the referenced-by list on this one is long — literally the most popular kid in school:

  • std::basic_streambuf< _CharT, _Traits >::in_avail()
  • std::basic_streambuf< _CharT, _Traits >::sbumpc()
  • std::basic_streambuf< _CharT, _Traits >::sgetc()
  • std::basic_stringbuf< _CharT, _Traits, _Alloc >::showmanyc()
  • std::basic_streambuf< _CharT, _Traits >::sputbackc()
  • std::basic_streambuf< _CharT, _Traits >::sungetc()
  • std::basic_streambuf< _CharT, _Traits >::uflow()
  • std::wbuffer_convert< _Codecvt, _Elem, _Tr >::underflow()

Everybody needs to know where the next char is. Understandable. 😌

🎀 basic_filebuf::imbue(const locale & __loc) — swap the translations

template<typename _CharT , typename _Traits > void std::basic_filebuf<
    _CharT, _Traits >::imbue (const locale & __loc)

[protected], [virtual], [inherited]

Changes translations. 🌍

Parameters: __loc — a new locale.

Translations done during I/O which depend on the current locale are changed by this call. And the standard adds — and I quote the vibe — "Between invocations of this function a class derived from streambuf can safely cache results of calls to locale functions and to members of facets so obtained." So basically: cache whatever you want between imbue calls, it's safe, it's sanctioned. 🫶

📌 Note: the base class version does nothing. Literally nothing. It's a no-op. The basic_filebuf override on this page is the one that actually does something.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

References std::ios_base::cur. (Curious choice of reference, but okay, noted. 🙈)

🌈 in_avail() — how many chars are sitting right there?

template<typename _CharT , typename _Traits > streamsize
    std::basic_streambuf< _CharT, _Traits >::in_avail ()

[inline], [inherited]

Looking ahead into the stream. 👀

Returns: the number of characters available.

Here's the logic: if a read position is available, it returns the number of characters available for reading before the buffer must be refilled. Otherwise, it returns the derived showmanyc(). So it's either "there's already stuff in the buffer, here's the count" or "ask the derived class, that's its business." ✨

References std::basic_streambuf< _CharT, _Traits >::egptr(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::showmanyc().

💫 basic_filebuf::is_open() — is the file actually open?

template<typename _CharT , typename _Traits > bool std::basic_filebuf<
    _CharT, _Traits >::is_open () const

[inline], [inherited]

Returns true if the external file is open. That's it. That's the whole function. A lil' boolean, doing its lil' job. 🎀

Referenced by std::basic_ifstream< _CharT, _Traits >::is_open(), std::basic_ofstream< _CharT, _Traits >::is_open(), and std::basic_fstream< _CharT, _Traits >::is_open().

🦋 basic_filebuf::open(const _Path & __s, ios_base::openmode __mode) — the filesystem::path one

template<typename _CharT , typename _Traits > template<typename _Path >
    _If_fs_path< _Path, __filebuf_type * > std::basic_filebuf< _CharT,
    _Traits >::open (const _Path & __s, ios_base::openmode __mode)

[inline], [inherited]

Opens an external file. 📂 Note the extra template<typename _Path > and that fancy _If_fs_path< _Path, __filebuf_type * > return type — this overload is constrained to things that are filesystem paths, iykyk.

Parameters:

  • __s — the name of the file, as a filesystem::path.
  • __mode — the open mode flags.

Returns: this on success, NULL on failure.

🔥 basic_filebuf::open(const char * __s, ios_base::openmode __mode) — the classic C-string one

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits
    >::__filebuf_type * std::basic_filebuf< _CharT, _Traits >::open (const
    char * __s, ios_base::openmode __mode)

[inherited]

Opens an external file. 📂 The O.G. version.

Parameters:

  • __s — the name of the file.
  • __mode — the open mode flags.

Returns: this on success, NULL on failure.

So here's how it actually behaves — and this part matters: if a file is already open, this function immediately fails. No closing, no swapping, no "oops I'll just reopen it" — it just fails, immediate, goodbye. Otherwise it tries to open the file named __s using the flags given in __mode.

And now, the iconic table. Table 92, adapted here, giving the relation between openmode combinations and the equivalent fopen() flags. (NB: lines app, in|out|app, in|app, binary|app, binary|in|out|app, and binary|in|app per DR 596.) 🔥

+---------------------------------------------------------+
| ios_base Flag combination            stdio equivalent   |
|binary  in  out  trunc  app                              |
+---------------------------------------------------------+
|             +                        w                  |
|             +           +            a                  |
|                         +            a                  |
|             +     +                  w                  |
|         +                            r                  |
|         +   +                        r+                 |
|         +   +     +                  w+                 |
|         +   +           +            a+                 |
|         +               +            a+                 |
+---------------------------------------------------------+
|   +         +                        wb                 |
|   +         +           +            ab                 |
|   +                     +            ab                 |
|   +         +     +                  wb                 |
|   +     +                            rb                 |
|   +     +   +                        r+b                |
|   +     +   +     +                  w+b                |
|   +     +   +           +            a+b                |
|   +     +               +            a+b                |
+---------------------------------------------------------+

Read it like a grid: tick the ios_base flags you passed, and the right column is the fopen() mode string you'd get. Slay. 💅

References std::ios_base::ate, std::ios_base::end, and std::basic_filebuf< _CharT, _Traits >::open() (yes, the other open() overload — recursion of the friendliest kind).

Referenced by std::basic_filebuf< _CharT, _Traits >::open(), 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(), and std::basic_ofstream< _CharT, _Traits >::open(). (Yes, those last few repeat — that's exactly how the page lists them, don't come for me. 🙈)

🍓 basic_filebuf::open(const std::string & __s, ios_base::openmode __mode) — the std::string one

template<typename _CharT , typename _Traits > __filebuf_type *
    std::basic_filebuf< _CharT, _Traits >::open (const std::string & __s,
    ios_base::openmode __mode)

[inline], [inherited]

Opens an external file. 📂 Third flavor, this time you hand it a std::string.

Parameters:

  • __s — the name of the file.
  • __mode — the open mode flags.

Returns: this on success, NULL on failure.

References std::basic_string< _CharT, _Traits, _Alloc >::c_str() — because eventually something's gotta be a const char*.

💀 basic_filebuf::overflow(int_type __c = _Traits::eof()) — flush it out

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits
    >::int_type std::basic_filebuf< _CharT, _Traits >::overflow (int_type
    __c = _Traits::eof())

[protected], [virtual], [inherited]

Consumes data from the buffer; writes to the controlled sequence. 💅

Parameters: __c — an additional character to consume. Default is _Traits::eof().

Returns: eof() to indicate failure, something else (usually __c, or not_eof()).

Informally — and the page literally says "informally", so we're being chill here — this function is called when the output buffer is full (or does not exist, as buffering need not actually be done). If a buffer exists, it is consumed, with some effect on the controlled sequence. (Typically, the buffer is written out to the sequence verbatim.) In either case, the character c is also written out, if __c is not eof().

📚 For a formal definition of this function, see a good text such as Langer & Kreft, or [27.5.2.4.5]/3-7. They said it, not me — go read the standard if you want the full rigorous moment. 🤓

Okay so like, you can totally make a functioning output streambuf by overriding just this one function (and no buffer area will be used at all, which is kinda iconic). 💅 Note: the base class version does nothing and returns eof(). It's reimplemented from std::basic_streambuf< _CharT, _Traits >. Refs: std::ios_base::app, std::ios_base::cur, and std::ios_base::out.

🦋 pbackfail

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits >::int_type std::basic_filebuf< _CharT, _Traits >::pbackfail (int_type __c = _Traits::eof()) [protected],  [virtual],  [inherited]

Tries to back up the input sequence. Like, rewinding a tiny bit. ⏪

Parameters:

  • __c — the character to be inserted back into the sequence.

Returns: eof() on failure, some other value on success.

Postcondition: The constraints of gptr(), eback(), and pptr() are the same as for underflow().

Note: Base class version does nothing, returns eof().

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

Refs: std::ios_base::cur, and std::ios_base::in.

🎀 pbase

template<typename _CharT , typename _Traits > char_type * std::basic_streambuf< _CharT, _Traits >::pbase () const [inline], [protected],  [inherited]

Access to the put area. These functions are only available to other protected functions, including derived classes. So like, protected vibes only. 🔒

  • pbase() returns the beginning pointer for the output sequence
  • pptr() returns the next pointer for the output sequence
  • epptr() returns the end pointer for the output sequence

Refs: std::basic_streambuf< _CharT, _Traits >::_M_out_beg.

Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc >::str().

🌸 pbump

template<typename _CharT , typename _Traits > void std::basic_streambuf< _CharT, _Traits >::pbump (int __n) [inline],  [protected],  [inherited]

Moving the write position. Just scooting it along. 🚶‍♀️

Parameters:

  • __n — the delta by which to move.

This just advances the write position without returning any data. No data returned, just vibes.

Refs: std::basic_streambuf< _CharT, _Traits >::_M_out_cur.

Referenced by std::basic_streambuf< _CharT, _Traits >::sputc().

🧚 pptr

template<typename _CharT , typename _Traits > char_type * std::basic_streambuf< _CharT, _Traits >::pptr () const [inline], [protected],  [inherited]

Access to the put area. These functions are only available to other protected functions, including derived classes. (Same crew as pbase, basically.) 👑

  • pbase() returns the beginning pointer for the output sequence
  • pptr() returns the next pointer for the output sequence
  • epptr() returns the end pointer for the output sequence

Refs: std::basic_streambuf< _CharT, _Traits >::_M_out_cur.

Referenced by std::basic_streambuf< _CharT, _Traits >::sputc().

💜 pubimbue

template<typename _CharT , typename _Traits > locale std::basic_streambuf< _CharT, _Traits >::pubimbue (const locale & __loc) [inline],  [inherited]

Entry point for imbue(). Like the bouncer at the locale club. 🌍

Parameters:

  • __loc — the new locale.

Returns: The previous locale.

Calls the derived imbue(__loc).

Refs: std::basic_streambuf< _CharT, _Traits >::_M_buf_locale, std::basic_streambuf< _CharT, _Traits >::getloc(), and std::basic_streambuf< _CharT, _Traits >::imbue().

⭐ pubseekoff

template<typename _CharT , typename _Traits > pos_type std::basic_streambuf< _CharT, _Traits >::pubseekoff (off_type __off, ios_base::seekdir __way, ios_base::openmode __mode = ios_base::in | ios_base::out) [inline],  [inherited]

Alters the stream position. Scoot scoot. 🛴

Parameters:

  • __off — offset.
  • __way — value for ios_base::seekdir.
  • __mode — value for ios_base::openmode.

Calls virtual seekoff function.

Refs: std::basic_streambuf< _CharT, _Traits >::seekoff().

🌈 pubseekpos

template<typename _CharT , typename _Traits > pos_type std::basic_streambuf< _CharT, _Traits >::pubseekpos (pos_type __sp, ios_base::openmode __mode = ios_base::in | ios_base::out) [inline],  [inherited]

Alters the stream position. (Same energy, different parameter.) ✨

Parameters:

  • __sp — position.
  • __mode — value for ios_base::openmode.

Calls virtual seekpos function.

Refs: std::basic_streambuf< _CharT, _Traits >::seekpos().

🍓 pubsetbuf

template<typename _CharT , typename _Traits > basic_streambuf * std::basic_streambuf< _CharT, _Traits >::pubsetbuf (char_type * __s, streamsize __n) [inline],  [inherited]

Entry points for derived buffer functions. The public versions of pubfoo dispatch to the protected derived foo member functions, passing the arguments (if any) and returning the result unchanged. So like, pubsetbuf calls setbuf behind the scenes. 🎬

Refs: std::basic_streambuf< _CharT, _Traits >::setbuf().

🔥 pubsync

template<typename _CharT , typename _Traits > int std::basic_streambuf< _CharT, _Traits >::pubsync () [inline],  [inherited]

Calls virtual sync function. Syncing up, bestie. 💫

Refs: std::basic_streambuf< _CharT, _Traits >::sync().

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

🫶 sbumpc

template<typename _CharT , typename _Traits > int_type std::basic_streambuf< _CharT, _Traits >::sbumpc () [inline],  [inherited]

Getting the next character. Gimme gimme. 🍬

Returns: The next character, or eof.

If the input read position is available, returns that character and increments the read pointer, otherwise calls and returns uflow().

Refs: std::basic_streambuf< _CharT, _Traits >::egptr(), std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::uflow().

Referenced by std::basic_istream< char >::get(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_streambuf< _CharT, _Traits >::snextc(), and std::basic_istream< char >::sync().

👑 seekoff

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits >::pos_type std::basic_filebuf< _CharT, _Traits >::seekoff (off_type, ios_base::seekdir, ios_base::openmode = ios_base::in | ios_base::out) [protected],  [virtual],  [inherited]

Alters the stream positions. Each derived class provides its own appropriate behavior. So like, do your own thing. 💅

Note: Base class version does nothing, returns a pos_type that represents an invalid stream position.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

Refs: std::ios_base::cur.

🦋 seekpos

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits >::pos_type std::basic_filebuf< _CharT, _Traits >::seekpos (pos_type, ios_base::openmode = ios_base::in | ios_base::out) [protected],  [virtual],  [inherited]

Alters the stream positions. Each derived class provides its own appropriate behavior. ✨

Note: Base class version does nothing, returns a pos_type that represents an invalid stream position.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

Refs: std::ios_base::beg.

🎀 setbuf

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits >::__streambuf_type * std::basic_filebuf< _CharT, _Traits >::setbuf (char_type * __s, streamsize __n) [protected],  [virtual],  [inherited]

Manipulates the buffer. Buffer wrangling, no cap. 🧺

Parameters:

  • __s — pointer to a buffer area.
  • __n — size of __s.

Returns: this

If no file has been opened, and both __s and __n are zero, then the stream becomes unbuffered. Otherwise, __s is used as a buffer; see https://gcc.gnu.org/onlinedocs/libstdc++/manual/streambufs.html#io.streambuf.buffering for more.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

🌸 setg

template<typename _CharT , typename _Traits > void std::basic_streambuf< _CharT, _Traits >::setg (char_type * __gbeg, char_type * __gnext, char_type * __gend) [inline],  [protected],  [inherited]

Setting the three read area pointers. 📍

Parameters:

  • __gbeg — a pointer.
  • __gnext — a pointer.
  • __gend — a pointer.

Postcondition: __gbeg == eback(), __gnext == gptr(), and __gend == egptr().

Refs: std::basic_streambuf< _CharT, _Traits >::_M_in_beg, std::basic_streambuf< _CharT, _Traits >::_M_in_cur, and std::basic_streambuf< _CharT, _Traits >::_M_in_end.

Referenced by std::wbuffer_convert< _Codecvt, _Elem, _Tr >::wbuffer_convert().

🧚 setp

template<typename _CharT , typename _Traits > void std::basic_streambuf< _CharT, _Traits >::setp (char_type * __pbeg, char_type * __pend) [inline],  [protected],  [inherited]

Setting the three write area pointers. (Well, two pointers, but the vibes are three.) ✍️

Parameters:

  • __pbeg — a pointer.
  • __pend — a pointer.

Postcondition: __pbeg == pbase(), __pbeg == pptr(), and __pend == epptr().

Refs: std::basic_streambuf< _CharT, _Traits >::_M_out_beg, std::basic_streambuf< _CharT, _Traits >::_M_out_cur, and std::basic_streambuf< _CharT, _Traits >::_M_out_end.

Referenced by std::wbuffer_convert< _Codecvt, _Elem, _Tr >::wbuffer_convert().

💜 sgetc

template<typename _CharT , typename _Traits > int_type std::basic_streambuf< _CharT, _Traits >::sgetc () [inline],  [inherited]

Getting the next character. Just peeking, not moving. 👀

Returns: The next character, or eof.

If the input read position is available, returns that character, otherwise calls and returns underflow(). Does not move the read position after fetching the character. So like, look but don't touch.

Refs: std::basic_streambuf< _CharT, _Traits >::egptr(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::underflow().

Referenced by std::basic_istream< char >::get(), std::basic_istream< _CharT, _Traits >::get(), std::basic_istream< _CharT, _Traits >::ignore(), std::basic_istream< char >::readsome(), and std::basic_streambuf< _CharT, _Traits >::snextc().

⭐ sgetn

template<typename _CharT , typename _Traits > streamsize std::basic_streambuf< _CharT, _Traits >::sgetn (char_type * __s, streamsize __n) [inline],  [inherited]

Entry point for xsgetn. 🚪

Parameters:

  • __s — a buffer area.
  • __n — a count.

Returns: xsgetn(__s,__n). The effect is to fill __s[0] through __s[__n-1] with characters from the input sequence, if possible.

Refs: std::basic_streambuf< _CharT, _Traits >::xsgetn().

🌈 showmanyc

template<typename _CharT , typename _Traits > streamsize std::basic_filebuf< _CharT, _Traits >::showmanyc () [protected],  [virtual],  [inherited]

Investigating the data available. Like a little detective for your input. 🔍

Returns: An estimate of the number of characters available in the input sequence, or -1.

If it returns a positive value, then successive calls to underflow() will not return traits::eof() until at least that number of characters have been supplied. If showmanyc() returns -1, then calls to underflow() or uflow() will fail. [27.5.2.4.3]/1

Note: Base class version does nothing, returns zero.

The standard adds that the intention is not only that the calls [to underflow or uflow] will not return eof() but that they will return immediately.

The standard adds that the morphemes of showmanyc are es-how-many-see, not show-manic. 😭 (This is real, bestie.)

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

Refs: std::ios_base::binary, and std::ios_base::in.

🌸 std::basic_streambuf::snextc() — the “next character, pls” moment

template<typename _CharT , typename _Traits > int_type std::basic_streambuf<
    _CharT, _Traits >::snextc () [inline],  [inherited]

Getting the next character. That’s the whole vibe.

  • Returns: The next character, or eof.

It Calls sbumpc(), and if that function returns traits::eof(), so does this function. Otherwise, sgetc().

  • References: std::basic_streambuf< _CharT, _Traits >::sbumpc(), and std::basic_streambuf< _CharT, _Traits >::sgetc()
  • Referenced by: std::basic_istream< char >::get(), std::basic_istream< char >::ignore(), std::basic_istream< char >::operator>>(), and std::basic_istream< char >::putback()

🦋 std::basic_streambuf::sputbackc() — pushing a character back into the input stream

template<typename _CharT , typename _Traits > int_type std::basic_streambuf<
    _CharT, _Traits >::sputbackc (char_type __c) [inline],  [inherited]

Pushing characters back into the input stream. It’s giving “wait, go back, I wasn’t done.”

  • Parameters: __c — the character to push back
  • Returns: The previous character, if possible

Similar to sungetc(), but __c is pushed onto the stream instead of the previous character. If successful, the next character fetched from the input stream will be __c.

  • References: std::basic_streambuf< _CharT, _Traits >::eback(), std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::pbackfail()
  • Referenced by: std::basic_istream< _CharT, _Traits >::putback()

💅 std::basic_streambuf::sputc() — single-character output, main character energy

template<typename _CharT , typename _Traits > int_type std::basic_streambuf<
    _CharT, _Traits >::sputc (char_type __c) [inline],  [inherited]

Entry point for all single-character output functions. Literally the doorway for one-character output.

  • Parameters: __c — a character to output
  • Returns: __c, if possible

One of two public output functions. Iconic.

If a write position is available for the output sequence (i.e., the buffer is not full), stores __c in that position, increments the position, and returns traits::to_int_type(__c). If a write position is not available, returns overflow(__c).

  • References: std::basic_streambuf< _CharT, _Traits >::epptr(), std::basic_streambuf< _CharT, _Traits >::overflow(), std::basic_streambuf< _CharT, _Traits >::pbump(), and std::basic_streambuf< _CharT, _Traits >::pptr()
  • Referenced by: std::wbuffer_convert< _Codecvt, _Elem, _Tr >::overflow()

✨ std::basic_streambuf::sputn() — multiple characters, one entry point

template<typename _CharT , typename _Traits > streamsize
    std::basic_streambuf< _CharT, _Traits >::sputn (const char_type * __s,
    streamsize __n) [inline],  [inherited]

Entry point for all single-character output functions. Yep, that’s what the original says — we’re keeping it exactly as written, bestie. Don’t come for me.

  • Parameters: __s — a buffer read area
  • Parameters: __n — a count

One of two public output functions.

Returns: xsputn(__s,__n). The effect is to write __s[0] through __s[__n-1] to the output sequence, if possible.

  • References: std::basic_streambuf< _CharT, _Traits >::xsputn()

🎀 std::basic_streambuf::sungetc() — moving backwards in the input stream

template<typename _CharT , typename _Traits > int_type std::basic_streambuf<
    _CharT, _Traits >::sungetc () [inline],  [inherited]

Moving backwards in the input stream. Reverse gear, but make it stream-coded.

  • Returns: The previous character, if possible

If a putback position is available, this function decrements the input pointer and returns that character. Otherwise, calls and returns pbackfail(). The effect is to unget the last character gotten.

  • References: std::basic_streambuf< _CharT, _Traits >::eback(), std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::pbackfail()

🧚 std::basic_filebuf::sync() — syncing the buffer arrays

template<typename _CharT , typename _Traits > int std::basic_filebuf<
    _CharT, _Traits >::sync () [protected],  [virtual],  [inherited]

Synchronizes the buffer arrays with the controlled sequences. Like making sure the group chat and the group chat backup agree.

  • Returns: -1 on failure

Each derived class provides its own appropriate behavior, including the definition of failure.

Note: Base class version does nothing, returns zero.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

🔥 std::basic_streambuf::uflow() — fetching more data from the controlled sequence

template<typename _CharT , typename _Traits > virtual int_type
    std::basic_streambuf< _CharT, _Traits >::uflow () [inline],
    [protected],  [virtual],  [inherited]

Fetches more data from the controlled sequence.

  • Returns: The first character from the pending sequence

Informally, this function does the same thing as underflow(), and in fact is required to call that function. It also returns the new character, like underflow() does. However, this function also moves the read position forward by one.

Reimplemented in __gnu_cxx::stdio_sync_filebuf< _CharT, _Traits >.

  • References: std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::underflow()
  • Referenced by: std::basic_streambuf< _CharT, _Traits >::sbumpc()

🫶 std::basic_filebuf::underflow() — fetching more data, the filebuf way

template<typename _CharT , typename _Traits > basic_filebuf< _CharT, _Traits
    >::int_type std::basic_filebuf< _CharT, _Traits >::underflow ()
    [protected],  [virtual],  [inherited]

Fetches more data from the controlled sequence.

  • Returns: The first character from the pending sequence

Informally, this function is called when the input buffer is exhausted (or does not exist, as buffering need not actually be done). If a buffer exists, it is refilled. In either case, the next available character is returned, or traits::eof() to indicate a null pending sequence.

For a formal definition of the pending sequence, see a good text such as Langer & Kreft, or [27.5.2.4.3]/7-14.

A functioning input streambuf can be created by overriding only this function (no buffer area will be used). For an example, see https://gcc.gnu.org/onlinedocs/libstdc++/manual/streambufs.html.

Note: Base class version does nothing, returns eof().

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

  • References: std::ios_base::in

🌈 std::basic_filebuf::xsgetn() — multiple character extraction

template<typename _CharT , typename _Traits > streamsize std::basic_filebuf<
    _CharT, _Traits >::xsgetn (char_type * __s, streamsize __n) [protected],
    [virtual],  [inherited]

Multiple character extraction. Grab a whole little stack of characters, not just one.

  • Parameters: __s — a buffer area
  • Parameters: __n — maximum number of characters to assign
  • Returns: The number of characters assigned

Fills __s[0] through __s[__n-1] with characters from the input sequence, as if by sbumpc(). Stops when either __n characters have been copied, or when traits::eof() would be copied.

It is expected that derived classes provide a more efficient implementation by overriding this definition.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

  • References: std::ios_base::in

🍓 std::basic_filebuf::xsputn() — multiple character insertion

template<typename _CharT , typename _Traits > streamsize std::basic_filebuf<
    _CharT, _Traits >::xsputn (const char_type * __s, streamsize __n)
    [protected],  [virtual],  [inherited]

Multiple character insertion. The “drop a bunch of characters into the output” move.

  • Parameters: __s — a buffer area
  • Parameters: __n — maximum number of characters to write
  • Returns: The number of characters written

Writes __s[0] through __s[__n-1] to the output sequence, as if by sputc(). Stops when either n characters have been copied, or when sputc() would return traits::eof().

It is expected that derived classes provide a more efficient implementation by overriding this definition.

Reimplemented from std::basic_streambuf< _CharT, _Traits >.

  • References: std::ios_base::app, and std::ios_base::out

🫶 Member Data Documentation 🫶

okay bestie, final stretch: these are the protected data members, some inherited, and they are literally the scaffolding of the buffer vibes. nothing skipped, not one bit. 💅

  • template<typename _CharT , typename _Traits > char_type* std::basic_filebuf< _CharT, _Traits >::_M_buf — [protected], [inherited]. Pointer to the beginning of internal buffer. the blueprint, the origin point, the main-character pointer. 🎀
  • template<typename _CharT , typename _Traits > locale std::basic_streambuf< _CharT, _Traits >::_M_buf_locale — [protected], [inherited]. Current locale setting. Referenced by std::basic_filebuf< _CharT, _Traits >::basic_filebuf(), std::basic_streambuf< _CharT, _Traits >::getloc(), and std::basic_streambuf< _CharT, _Traits >::pubimbue(). locale girlie is everywhere, iykyk. 🌸
  • template<typename _CharT , typename _Traits > size_t std::basic_filebuf< _CharT, _Traits >::_M_buf_size — [protected], [inherited]. Actual size of internal buffer. This number is equal to the size of the put area + 1 position, reserved for the overflow char of a full area. math but make it buffer lore. ✨
  • template<typename _CharT , typename _Traits > char* std::basic_filebuf< _CharT, _Traits >::_M_ext_buf — [protected], [inherited]. Buffer for external characters. Used for input when codecvt::always_noconv() == false. When valid, this corresponds to eback(). external-character storage said slay. 🦋
  • template<typename _CharT , typename _Traits > streamsize std::basic_filebuf< _CharT, _Traits >::_M_ext_buf_size — [protected], [inherited]. Size of buffer held by _M_ext_buf. simple, iconic, no notes. 💖
  • template<typename _CharT , typename _Traits > const char* std::basic_filebuf< _CharT, _Traits >::_M_ext_next — [protected], [inherited]. Pointers into the buffer held by _M_ext_buf that delimit a subsequence of bytes that have been read but not yet converted. When valid, _M_ext_next corresponds to egptr(). unread-but-not-converted bytes are lowkey mysterious. 👑
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_beg — [protected], [inherited]. Start of get area. Referenced by std::basic_streambuf< _CharT, _Traits >::eback(), and std::basic_streambuf< _CharT, _Traits >::setg(). the get area starts here, periodt. 🫶
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_cur — [protected], [inherited]. Current read area. Referenced by std::basic_streambuf< _CharT, _Traits >::gbump(), std::basic_streambuf< _CharT, _Traits >::gptr(), and std::basic_streambuf< _CharT, _Traits >::setg(). current read position has main character energy. 💅
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_in_end — [protected], [inherited]. End of get area. Referenced by std::basic_streambuf< _CharT, _Traits >::egptr(), and std::basic_streambuf< _CharT, _Traits >::setg(). the get area said "that's a wrap." 🎬
  • template<typename _CharT , typename _Traits > ios_base::openmode std::basic_filebuf< _CharT, _Traits >::_M_mode — [protected], [inherited]. Place to stash in || out || in | out settings for current filebuf. Referenced by std::basic_filebuf< _CharT, _Traits >::close(). the mode-hiding spot, no cap. 🔥
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_beg — [protected], [inherited]. Start of put area. Referenced by std::basic_streambuf< _CharT, _Traits >::pbase(), and std::basic_streambuf< _CharT, _Traits >::setp(). put area origin story. 🌈
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_cur — [protected], [inherited]. Current put area. Referenced by std::basic_streambuf< _CharT, _Traits >::pbump(), std::basic_streambuf< _CharT, _Traits >::pptr(), and std::basic_streambuf< _CharT, _Traits >::setp(). writing is happening, bestie. ✍️
  • template<typename _CharT , typename _Traits > char_type* std::basic_streambuf< _CharT, _Traits >::_M_out_end — [protected], [inherited]. End of put area. Referenced by std::basic_streambuf< _CharT, _Traits >::epptr(), and std::basic_streambuf< _CharT, _Traits >::setp(). put area boundary, iconic behavior. ⭐
  • template<typename _CharT , typename _Traits > char_type std::basic_filebuf< _CharT, _Traits >::_M_pback — [protected], [inherited]. Necessary bits for putback buffer management.
Note: pbacks of over one character are not currently supported. one-char putback only, do not push it. 😭
  • template<typename _CharT , typename _Traits > char_type* std::basic_filebuf< _CharT, _Traits >::_M_pback_cur_save — [protected], [inherited]. Necessary bits for putback buffer management.
Note: pbacks of over one character are not currently supported. same warning, same vibe check. 🙈
  • template<typename _CharT , typename _Traits > char_type* std::basic_filebuf< _CharT, _Traits >::_M_pback_end_save — [protected], [inherited]. Necessary bits for putback buffer management.
Note: pbacks of over one character are not currently supported. plural pbacks? not today. 💀
  • template<typename _CharT , typename _Traits > bool std::basic_filebuf< _CharT, _Traits >::_M_pback_init — [protected], [inherited]. Necessary bits for putback buffer management. Referenced by std::basic_filebuf< _CharT, _Traits >::close().
Note: pbacks of over one character are not currently supported. the putback buffer said keep it one character, bestie. 🍓
  • template<typename _CharT , typename _Traits > bool std::basic_filebuf< _CharT, _Traits >::_M_reading — [protected], [inherited]. _M_reading == false && _M_writing == false for uncommitted mode; _M_reading == true for read mode; _M_writing == true for write mode;

NB: _M_reading == true && _M_writing == true is unused.

Referenced by std::basic_filebuf< _CharT, _Traits >::close(). read mode vs write mode vs uncommitted mode — the state machine is state machining. 🧚

👑 Author 👑

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

and that's the whole page, bestie — auto-generated by Doxygen for libstdc++, with the source/version and date hanging out in the footer and the libstd__gnu_cxx::std...harT, _Traits >(3cxx) tag doing its little end-credits moment. no cap, iconic, periodt. 💖✨

📦 where this page comes from