std::basic_...ambuf::uflow(3)

πŸ“¦ version 2024.07.05, in nixpkgs unstable, opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay so bestie, welcome to the std::basic_...ambuf::uflow(3) page from the C++ Standard Libary manual ✨. This is all about std::basic_streambuf::uflow - std::basic_streambuf::uflow. It's giving protected virtual function energy, and we're gonna get you through it 🫢.


🌸 Synopsis 🌸

          protected:
          virtual int_type uflow();

So what's the vibe? uflow() makes sure at least one character is available in the input area by updating the pointers to the input area (if needed). On success, it returns the value of that character and advances the value of the get pointer by one character. On failure, it returns traits::eof() 😭.

The function may update gptr, egptr and eback pointers to define the location of newly loaded data (if any). On failure, the function ensures that either gptr() == nullptr or gptr() == egptr.

The base class version of the function calls underflow() and increments gptr(). iconic behavior, honestly πŸ‘‘.

πŸŽ€ Parameters πŸŽ€

  • (none) β€” literally no parameters, bestie. none. zero. periodt πŸ’….

πŸ¦‹ Return value πŸ¦‹

The value of the character that was pointed to by the get pointer before it was advanced by one, or traits::eof() otherwise.

The base class version of the function returns the value returned by underflow().

πŸ’… Note πŸ’…

The public functions of std::streambuf call this function only if gptr() == nullptr or gptr() >= egptr().

The custom streambuf classes that do not use the get area and do not set the get area pointers in basic_streambuf are required to override this function.

πŸ“ Example πŸ“

This section is incomplete Reason: no example

so yeah, no example here bestie 😭. the manual is literally telling us it's incomplete. not me being left on read by the example section πŸ’€.

🌈 See also 🌈

  • underflow β€” reads characters from the associated input sequence to the get area [virtual] (virtual protected member function)
  • overflow β€” writes characters to the associated output sequence from the put area [virtual] (virtual protected member function)

πŸ‘‘ Category πŸ‘‘

  • Todo no example

okay that's the whole page, bestie 🫢 β€” source/version: http://cppreference.com, date: 2024.06.10, and the page is std::basic_...ambuf::uflow(3). mwah πŸ’‹

πŸ“¦ where this page comes from