std::basic_spanbuf
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Input/output library
Print functions (C++23)
Buffers
basic_spanbuf
(C++23)
(C++98/26*)
(C++20)
Streams
Abstractions
File I/O
String I/O
Array I/O
(C++23)
(C++23)
(C++23)
(C++98/26*)
(C++98/26*)
(C++98/26*)
Synchronized Output
(C++20)
Types
Error category interface
(C++11)
(C++11)
std::basic_spanbuf
Public member functions
(C++23)
(C++23)
(C++23)
(C++23)
Protected member functions
(C++23)
(C++23)
(C++23)
Non-member functions
(C++23)
Defined in header
<spanstream>
template<
(since C++23)
class CharT,
class Traits = std::char_traits <CharT>
> class basic_spanbuf
std::basic_spanbuf is a std::basic_streambuf whose associated character sequence is a memory-resident sequence of arbitrary characters, which can be initialized from or made available as an instance of std::span <CharT>.
std::basic_spanbuf performs I/O on a fixed buffer, and therefore it does not attempt to obtain a new buffer when the underlying buffer is exhausted.
Several typedefs for common character types are provided:
Defined in header
<spanstream> Type
Definition
std::spanbuf
std::basic_spanbuf<char>
std::wspanbuf
std::basic_spanbuf<wchar_t>
Contents
[edit] Member types
Member type
Definition
[edit] Data members
Member name
Definition
buf (private)
A std::span <CharT> referencing the underlying buffer.(exposition-only member object*)
[edit] Member functions
Public member functions
(destructor)
[virtual]
basic_spanbuf object (virtual public member function)
Protected member functions
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[edit] Non-member functions
Inherited from std::basic_streambuf
Member types
Member type
Definition
Member functions
[virtual]
basic_streambuf object (virtual public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Locales
changes the associated locale and invokes imbue()
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
obtains a copy of the associated locale
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Positioning
Get area
obtains the number of characters immediately available in the get area
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
advances the input sequence, then reads one character without advancing again
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
(removed in C++17)
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
reads one character from the input sequence without advancing the sequence
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Put area
writes one character to the put area and advances the next pointer
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Putback
puts one character back in the input sequence
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
moves the next pointer in the input sequence back by one
(public member function of
(public member function of
std::basic_streambuf<CharT,Traits>) [edit]
Protected member functions
Locales
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
Positioning
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
Get area
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
returns a pointer to the beginning, current character and the end of the get area
(protected member function) [edit]
(protected member function) [edit]
repositions the beginning, next, and end pointers of the input sequence
(protected member function) [edit]
(protected member function) [edit]
Put area
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
[virtual]
(virtual protected member function of
std::basic_streambuf<CharT,Traits>) [edit]
returns a pointer to the beginning, current character and the end of the put area
(protected member function) [edit]
(protected member function) [edit]
repositions the beginning, next, and end pointers of the output sequence
(protected member function) [edit]
(protected member function) [edit]
Putback
[edit] Notes
std::basic_spanbuf does not own the underlying buffer.
It is the responsibility of programmers to ensure the underlying buffer is in its lifetime when used by a std::basic_spanbuf object. Additional synchronization may be needed if more than one thread operates the same underlying buffer through different std::basic_spanbuf objects.
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_spanstream |
202106L |
(C++23) | std::spanbuf, std::spanstream
|