std::basic_filebuf
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_filebuf
(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_filebuf
Public member functions
(C++11)
(C++11)
(C++26)
Protected member functions
Non-member functions
(C++11)
Defined in header
<fstream>
template<
class CharT,
class Traits = std::char_traits <CharT>
std::basic_filebuf is a std::basic_streambuf whose associated character sequence is a file. Both the input sequence and the output sequence are associated with the same file, and a joint file position is maintained for both operations. The restrictions on reading and writing a sequence with std::basic_filebuf are the same as std::FILE s.
The functions underflow() and overflow() / sync() perform the actual I/O between the file and the get and put areas of the buffer. When CharT is not char, most implementations store multibyte characters in the file and a std::codecvt facet is used to perform wide/multibyte character conversion.
Several typedefs for common character types are provided:
Defined in header
<fstream> Type
Definition
std::filebuf
std::basic_filebuf<char>
std::wfilebuf
std::basic_filebuf<wchar_t>
Contents
[edit] Member types
Type
Definition
native_handle_type(C++26)
implementation-defined type that is TriviallyCopyable and semiregular [edit]
[edit] Member functions
Public member functions
[virtual]
basic_filebuf object and closes the file if it is open (virtual public member function) [edit]
Protected member functions
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[virtual]
(virtual protected member function) [edit]
[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
| Feature-test macro | Value | Std | Feature |
|---|---|---|---|
__cpp_lib_fstream_native_handle |
202306L |
(C++26) | native handles support |