std::basic_spanbuf::setbuf(3)

std::basic_spanbuf::setbuf(3) 💅

okay so this is the C++ Standard Libary manual page for std::basic_spanbuf::setbuf — and yes bestie, the header spells it “Libary,” we’re keeping that exactly as-is, no editing the icon.

---

🌸 NAME

std::basic_spanbuf::setbuf — std::basic_spanbuf::setbuf. That’s the whole NAME section, no cap.

---

✨ Synopsis ✨

protected:
std::basic_streambuf<CharT, Traits>* setbuf( CharT *s,
std::streamsize n ) override;

(since C++23) — bestie, this one is new new.

Makes the basic_spanbuf perform I/O on the buffer [s, s + n). Equivalently calls this->span(std::span<CharT>(s, n)) and then returns this.

Here’s the pointer vibe check:

• Set bits in open mode (affecting pointers to get area): std::ios_base::in
  • Return value after setting eback(): s
  • Return value after setting gptr(): s
  • Return value after setting egptr(): s + n
• Set bits in open mode (affecting pointers to put area): std::ios_base::out && !std::ios_base::ate
  • Return value after setting pbase(): s
  • Return value after setting pptr(): s
  • Return value after setting epptr(): s + n
• Set bits in open mode (affecting pointers to put area): std::ios_base::out && std::ios_base::ate
  • Return value after setting pbase(): s
  • Return value after setting pptr(): s + n
  • Return value after setting epptr(): s + n

This function is protected virtual, it may only be called through pubsetbuf() or from member functions of a user-defined class derived from std::basic_spanbuf.

---

🎀 Parameters

• s — pointer to the first CharT in the user-provided buffer.
• n — the number of CharT elements in the user-provided buffer.

---

🌈 Return value

this — that’s it, that’s the return value, periodt.

---

🦋 Notes

The deprecated stream buffer std::strstreambuf or the boost.IOStreams device boost::basic_array can also implement I/O buffering over a user-provided char array.

---

🧪 Example

This section is incomplete — Reason: no example. Not me showing up with zero example 💀

---

👀 See also

• pubsetbuf invokes setbuf() — public member function of std::basic_streambuf<CharT,Traits>.
• setbuf attempts to replace the controlled character sequence with an array [virtual] — virtual protected member function of std::basic_stringbuf<CharT,Traits,Allocator>.
• setbuf attempts to replace the controlled character sequence with an array [virtual] — virtual protected member function of std::strstreambuf.

---

🏷️ Category

* Todo no example

---

source/version: cppreference.com; date: 2024.06.10 — mwah, go slay those buffers, bestie 💋✨